customDataPlotDefaults {iSEE} | R Documentation |
Create default settings for custom data plot panels in the iSEE interface.
customDataPlotDefaults(se, number)
se |
A SummarizedExperiment object. |
number |
An integer scalar, specifying the maximum number of custom data plots that can be added to the interface. |
Data parameters available to custom data plots are:
DataBoxOpen
:Logical, should the data parameter box be open upon initialization?
Defaults to FALSE
.
Function
:String, which function should be used to generate the ggplot for the curent panel?
Defaults to "---"
, i.e., no coordinates are generated.
Arguments
:String with multiple lines specifying the initial arguments for the function, see vignette("custom", package="iSEE")
for details.
Defaults to an empty string.
VisibleArgs
:String with multiple lines specifying the initial arguments to be shown in the text area.
This can differ from Arguments
, e.g., to list argument names without their values for users to enter.
Defaults to NA
, which means that the value in Arguments
will be shown.
Selection parameters for custom data plots are:
SelectBoxOpen
:Logical, should the selection parameter box be open upon initialization?
Defaults to FALSE
.
ColumnSource
:Character, which other plot should transmit sample selections to the current plot?
Defaults to "---"
, which means that no plot is used for point selection.
RowSource
:Character, which other plot should transmit feature selections to the current plot?
Defaults to "---"
, which means that no plot is used for point selection.
A DataFrame containing default settings for parameters of each of number
custom data plot panels.
Aaron Lun, Kevin Rue-Albrecht
example(SingleCellExperiment, echo=FALSE) # mock up 'sce'. customDataPlotDefaults(sce, n=1)