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

« back to all changes in this revision

Viewing changes to man/dimensionality.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:
 
1
\name{Dimensionality Reduction}
 
2
\alias{MDSplot}
 
3
\alias{MDSplot,CuffData-method}
 
4
\alias{PCAplot}
 
5
\alias{PCAplot,CuffData-method}
 
6
%- Also NEED an '\alias' for EACH other topic documented here.
 
7
\title{
 
8
Dimensionality reduction utilities
 
9
}
 
10
\description{
 
11
Dimensionality reduction plots for feature selection and extraction for cummeRbund
 
12
}
 
13
\usage{
 
14
\S4method{MDSplot}{CuffData}(object,replicates=FALSE,logMode=TRUE,pseudocount=1.0)
 
15
\S4method{PCAplot}{CuffData}(object,x="PC1", y="PC2",replicates=FALSE,pseudocount=1.0,scale=TRUE,...)
 
16
}
 
17
%- maybe also 'usage' for other objects documented here.
 
18
\arguments{
 
19
  \item{object}{
 
20
The output of class CuffData from which to draw expression estimates. (e.g. genes(cuff))
 
21
}
 
22
  \item{x}{
 
23
For PCAplot, indicates which principal component is to be presented on the x-axis (e.g. "PC1","PC2","PC3", etc) 
 
24
}
 
25
  \item{y}{
 
26
See x.
 
27
}
 
28
  \item{pseudocount}{
 
29
Value added to FPKM to avoid log transformation issues.
 
30
}
 
31
  \item{logMode}{
 
32
Logical value whether or not to use log-transformed expression estimates (default: TRUE)
 
33
}
 
34
  \item{replicates}{
 
35
A logical value to indicate whether or not individual replicate expression estimates will be used.
 
36
}
 
37
  \item{scale}{
 
38
For PCAplot, a logical value passed directly to prcomp.
 
39
}
 
40
  \item{\dots}{
 
41
Additional passthrough arguments (may not be fully implemented yet). 
 
42
}
 
43
}
 
44
\details{
 
45
These methods attempt to project a matrix of expression estimates across conditions and/or replicates onto a smaller number of dimesions for feature selection, feature extraction, and can
 
46
also be useful for outlier detection.
 
47
 
 
48
}               
 
49
\value{
 
50
A ggplot2 object.
 
51
}
 
52
\references{
 
53
None.
 
54
}
 
55
\author{
 
56
Loyal A. Goff
 
57
}
 
58
\note{
 
59
None.
 
60
}
 
61
 
 
62
 
 
63
\examples{
 
64
        cuff<-readCufflinks(system.file("extdata", package="cummeRbund")) #Create CuffSet object from sample data
 
65
        p<-PCAplot(genes(cuff),x="PC2",y="PC3",replicates=TRUE)
 
66
        m<-MDSplot(genes(cuff),replicates=TRUE)
 
67
        p #Render PCA plot
 
68
        m #Render MDS plot
 
69
        
 
70
}
 
71