visual-parameters-generics {iSEE}R Documentation

Generics for visual DotPlot parameters

Description

These generics allow subclasses to override the user interface elements controlling visual parameters of DotPlot panels.

Interface definition

In all of the code snippets below, x is a Panel instance and se is the SummarizedExperiment object.

A method for any of these generics may also return NULL, in which case the corresponding section of the visual parameter box is completely hidden.

All of these generics are called by .defineInterface for DotPlot subclasses. Developers of subclasses can simply specialize these generics to change the UI instead of reimplementing .defineInterface itself.

When implementing methods for these generics, it is a good idea to make use of information precomputed by .cacheCommonInfo. For example, .cacheCommonInfo,ColumnDotPlot-method will add vectors specifying whether a variable in the colData is valid and discrete or continuous.

Controlling ColorBy*Data choices

.allowableColorByDataChoices(x, se) should return a character vector of the allowable row/column data variables to use when ColorBy is set to "Row data" or "Column data" for RowDotPlots and ColumnDotPlots, respectively. The default method will use all available (atomic) variables, but subclasses can specialize this to only allow, e.g., continuous or discrete variables.

Author(s)

Kevin Rue-Albrecht


[Package iSEE version 2.5.3 Index]