Description Usage Arguments Value Slots
Constructor of the esetPlot class
1 2 | ## S4 method for signature 'esetPlot'
initialize(.Object, ...)
|
.Object |
esetPlot object |
... |
additional class arguments |
S4 object of class esetPlot
dataPlotSamplesdata.frame with columns 'X', 'Y' with coordinates
for the samples and with rownames which
should correspond and be in the same order as the sampleNames of
esetUsed
dataPlotGenesdata.frame with two columns 'X' and 'Y' with coordinates for the genes
esetexpressionSet (or SummarizedExperiment) object with data
colorVarname of variable (in varLabels of the eset) used
for coloring, empty by default
colorcharacter or factor with specified color(s) for the points,
replicated if needed. This is used only if colorVar is empty.
By default: 'black' if colorVar is not specified and default
ggplot palette otherwise
shapeVarname of variable (in varLabels of the eset)
used for the shape, empty by default
shapecharacter or factor with specified shape(s) (pch) for the points,
replicated if needed. This is used only if shapeVar is empty.
By default: '15' (filled square) if shapeVar is not specified
and default ggplot shape(s) otherwise
sizeVarname of variable (in varLabels of the eset)
used for the size, empty by default
sizesize character or factor with specified size(s) (cex) for the points,
replicated if needed.
This is used only if sizeVar is empty.
By default: '2.5' if sizeVar is not specified and default
ggplot size(s) otherwise
sizeRange,size (cex) range used in the plot, possible only
if the sizeVar is 'numeric' or 'integer'
alphaVarname of variable (in varLabels of the eset)
used for the transparency, empty by default.
alphaalpha character or factor with specified transparency(s) for the points,
replicated if needed. This is used only if shapeVar is empty.
By default: '1' if alphaVar is not specified and default
ggplot alpha otherwise.
alphaRangetransparency (alpha) range used in the plot,
possible only if the alphaVar is 'numeric' or 'integer'
This parameter is not available for rbokeh plot.
symmetryAxesset symmetry for axes, either:
'combine' (by default): both axes are symmetric and with the same limits
'separate': each axis is symmetric and has its own limits
'none': axes by default (plot limits)
cloudGeneslogical, if TRUE (by default), include the cloud of genes in the spectral map
cloudGenesColorif cloudGenes is TRUE,
color for the cloud of genes, black by default
cloudGenesNBinsnumber of bins to used for the clouds of genes, by default the square root of the number of genes
cloudGenesIncludeLegendlogical, if TRUE (FALSE by default) include the legend for the cloud of genes (in the top position if multiple legends)
cloudGenesTitleLegendstring with title for the legend for the cloud of genes 'nGenes' by default
packageTextLabelpackage used to label the outlying genes/samples/gene sets,
either ggrepel (by default, only used if package ggrepel is available),
or ggplot2
topGenesnumeric indicating which percentile (if <1) or number (if >=1) of genes most distant to the origin of the plot to annotate, by default: 10 genes are selected If no genes should be annotated, set this parameter to 0 Currently only available for static plot.
topGenesCexcex for gene annotation (used when topGenes > 0)
topGenesVarvariable of the featureData used to label the genes,
by default: empty, the featureNames are used for labelling (used when topGenes > 0)
topGenesJusttext justification for the genes
(used when topGenes > 0 and if packageTextLabel is ggplot2),
by default: c(0.5, 0.5) so centered
topGenesColortext color for the genes
(used when topGenes > 0), black by default
topSamplesnumeric indicating which percentile (if <1) or number (if >=1) of samples most distant to the origin of the plot to annotate, by default: 10 samples are selected If no samples should be annotated, set this parameter to 0. Currently available for static plot.
topSamplesCexcex for sample annotation (used when topSamples > 0)
topSamplesVarvariable of the phenoData used to label the samples,
by default: empty, the sampleNames are used for labelling
(used when topSamples > 0)
topSamplesJusttext justification for the samples
(used when topSamples > 0 and if packageTextLabel is ggplot2),
by default: c(0.5, 0.5) so centered
topSamplesColortext color for the samples
(used when topSamples > 0), black by default
geneSetslist of gene sets/pathways, each containing
identifiers of genes contained in the set.
E.g. pathways from Gene Ontology databases output from the
getGeneSetsForPlot function or any custom list of pathways.
The genes identifiers should correspond to the variable
geneSetsVar contained in the phenoData, if not specified
the featureNames are used.
If several gene sets have the same name, they will be
combine to extract the top gene sets.
geneSetsVarvariable of the featureData used to
match the genes contained in geneSets,
most probably ENTREZID, if not specified the featureNames
of the eSet are used
Only used when topGeneSets > 0 and the parameter
geneSets is specified.
geneSetsMaxNCharmaximum number of characters for pathway names,
by default keep entire names
Only used when topGeneSets > 0 and the parameter geneSets is specified.
topGeneSetsnumeric indicating which percentile (if <=1) or number (if >1) of gene sets
most distant to the origin of the plot to annotate, by default: 10 gene sets are selected
If no gene sets should be annotated, set this parameter to 0.
Currently available for static plot.
Only used when topGeneSets > 0 and the parameter geneSets is specified.
topGeneSetsCexcex for gene sets annotation
Only used when topGeneSets > 0 and the parameter geneSets is specified.
topGeneSetsJusttext justification for the gene sets
by default: c(0.5, 0.5) so centered
Only used when topGeneSets > 0, the parameter geneSets
is specified and if packageTextLabel is ggplot2.
topGeneSetsColorcolor for the gene sets
(used when topGeneSets > 0 and geneSets is specified), black by default
Only used when topGeneSets > 0 and the parameter geneSets is specified.
includeLegendlogical if TRUE (by default) include a legend, otherwise not
includeLineOriginif TRUE (by default) include vertical line at x = 0 and horizontal line at y = 0
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.