← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/csDistHeat.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/csDistHeat.Rd
 
1
\name{csDistHeat}
 
2
\alias{csDistHeat}
 
3
\alias{csDistHeat,CuffFeatureSet-method}
 
4
\alias{csDistHeat,CuffData-method}
 
5
 
 
6
\title{
 
7
  csDistHeat
 
8
}
 
9
\description{
 
10
  Creates a ggplot plot object with a geom_tile layer of JS Distance
 
11
  values between samples or genes.
 
12
}
 
13
\usage{
 
14
\S4method{csDistHeat}{CuffFeatureSet}(object, replicates=F, samples.not.genes=T,
 
15
  logMode=T, pseudocount=1.0,
 
16
  heatscale=c(low='lightyellow',mid='orange',high='darkred'),
 
17
  heatMidpoint=NULL, ...)
 
18
}
 
19
 
 
20
\arguments{
 
21
  \item{object}{
 
22
    An object of class 'CuffFeatureSet' or 'CuffGeneSet'
 
23
  }
 
24
   \item{replicates}{
 
25
    A logical argument whether or not to use individual replicate FPKM values as opposed to condition FPKM estimates. (default: FALSE)
 
26
  }
 
27
  \item{samples.not.genes}{
 
28
    Compute distances between samples rather than genes. If False,
 
29
    compute distances between genes.
 
30
  }
 
31
  \item{logMode}{
 
32
    A logical argument to log10-transform FPKM values prior to plotting.
 
33
  }
 
34
  \item{pseudocount}{
 
35
    Value to be added to FPKM for appropriate log transformation and clustering. (Avoids zero-based errors)
 
36
  }
 
37
  \item{heatscale}{
 
38
    A list with min length=2, max length=3 that describe the the color scale.
 
39
  }
 
40
  \item{heatMidpoint}{
 
41
    Value for midpoint of color scale.
 
42
  }
 
43
  \item{\dots}{
 
44
    Additional arguments to csHeatmap
 
45
  }
 
46
}
 
47
\details{
 
48
  None
 
49
}
 
50
\value{
 
51
  A ggplot2 plot object with a geom_tile layer to display distance
 
52
  between samples or genes.
 
53
}
 
54
\references{
 
55
  None
 
56
}
 
57
\author{
 
58
  Loyal A. Goff, Cole Trapnell, and David Kelley
 
59
}
 
60
\note{
 
61
  None
 
62
}
 
63
 
 
64
\examples{
 
65
        data(sampleData)
 
66
        csDistHeat(sampleGeneSet) 
 
67
}
 
68
 
 
69
\keyword{heatmap}
 
70
\keyword{Jensen-Shannon}
 
71
\keyword{distance}