← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/sigMatrix.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/sigMatrix.Rd
 
1
\name{sigMatrix}
 
2
\alias{sigMatrix}
 
3
\alias{sigMatrix,CuffSet-method}
 
4
 
 
5
 
 
6
\title{
 
7
sigMatrix
 
8
}
 
9
\description{
 
10
Returns a ggplot2 plot object representing a matrix of significant features. This is a useful synopsis of all significant pairwise comparisons within the dataset.
 
11
}
 
12
\usage{
 
13
\S4method{sigMatrix}{CuffSet}(object,alpha=0.05,level='genes',orderByDist=FALSE)
 
14
}
 
15
%- maybe also 'usage' for other objects documented here.
 
16
\arguments{
 
17
  \item{object}{
 
18
An object of class CuffSet.
 
19
}
 
20
  \item{alpha}{
 
21
An alpha value by which to filter multiple-testing corrected q-values to determine significance
 
22
}
 
23
  \item{level}{
 
24
Feature level to be queried for significance (must be one of c('genes','isoforms','TSS','CDS')
 
25
}
 
26
  \item{orderByDist}{
 
27
Logical. If TRUE then samples are re-ordered based on JS-distance from one another (fairly useless unless you have a specific need for this).
 
28
}
 
29
}
 
30
\details{
 
31
Creates a matrix plot to illustrate the number of significant features of type 'level' at a given alpha from a cuffdiff run.
 
32
}
 
33
\value{
 
34
A ggplot2 plot object
 
35
}
 
36
\references{
 
37
None
 
38
}
 
39
\author{
 
40
Loyal A. Goff
 
41
}
 
42
\note{
 
43
None
 
44
}
 
45
 
 
46
 
 
47
\examples{
 
48
        a<-readCufflinks(system.file("extdata", package="cummeRbund")) #Create CuffSet object from sample data
 
49
        d<-sigMatrix(a) #Create csDensity plot
 
50
        d #Render plot
 
51
}