← Back to branch summary

~ubuntu-branches/ubuntu/utopic/r-bioc-cummerbund/utopic

« back to all changes in this revision

Viewing changes to man/csVolcano.Rd

  • Committer: Package Import Robot
  • Author(s): Andreas Tille
  • Date: 2013-12-28 17:17:25 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20131228171725-polmzo8go4m371c6
Tags: 2.4.1-1
* New upstream version
* debian/rules: Remove useless creation of ${R-Depends}
* debian/control: Versioned Build-Depends: r-base-dev (>= 3.0)
* debian/README.test: add hint how to test the package

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/csVolcano.Rd
1
1
\name{csVolcano}
2
2
\alias{csVolcano}
 
3
\alias{csVolcanoMatrix}
3
4
\alias{csVolcano,CuffData-method}
 
5
\alias{csVolcanoMatrix,CuffData-method}
4
6
\alias{csVolcano,CuffFeatureSet-method}
5
7
%- Also NEED an '\alias' for EACH other topic documented here.
6
8
\title{
10
12
Creates a volcano plot of log fold change in expression vs -log(pval) for a pair of samples (x,y)
11
13
}
12
14
\usage{
13
 
\S4method{csVolcano}{CuffData}(object, x, y, features=FALSE, xlimits = c(-20, 20), ...)
 
15
\S4method{csVolcano}{CuffData}(object, x, y, alpha=0.05, showSignificant=TRUE,features=FALSE, xlimits = c(-20, 20), ...)
 
16
\S4method{csVolcanoMatrix}{CuffData}(object,alpha=0.05,xlimits=c(-20,20),mapping=aes(),...)
14
17
}
15
18
%- maybe also 'usage' for other objects documented here.
16
19
\arguments{
23
26
  \item{y}{
24
27
Sample name from 'samples' table for comparison
25
28
}
 
29
  \item{alpha}{
 
30
Provide an alpha cutoff for visualizing significant genes
 
31
}
 
32
  \item{showSignificant}{
 
33
A logical value whether or not to distinguish between significant features or not (by color).
 
34
}
26
35
  \item{features}{
27
36
Will include all fields from 'features' slot in returned ggplot object.
28
37
Useful for further manipulations of plot object using feature-level attributes (e.g. gene_type, class_code, etc)
30
39
  \item{xlimits}{
31
40
Set boundaries for x limits to avoid infinity plotting errors. [Default c(-20,20)]
32
41
}
 
42
  \item{mapping}{
 
43
Passthrough argument for ggplot aesthetics. Can be ignored completely. 
 
44
}
33
45
  \item{\dots}{
34
46
Additional arguments
35
47
}