iSEE selection parameters {iSEE} | R Documentation

## Selection parameters

### Description

Parameters that control the selection of transmitter plots and the effect of selection in a variety of panels.

### Selection parameters for plots

`SelectBoxOpen`:

  Logical, should the selection parameter box be open upon initialization? Defaults to `FALSE`.

`SelectByPlot`:

  Character, which other plot should be used for point selection in the current plot? Defaults to `"---"`, which means that no plot is used for point selection.

`SelectEffect`:

  Character, what is the effect of receiving point selection information? Can be `"Restrict"`, where only the selected points are shown; `"Color"`, where the selected points have a different color; or `"Transparent"`, where all points other than those selected are made transparent. Defaults to `"Transparent"`.

`SelectColor`:

  Character, what color should be used for the selected points when `SelectEffect="Color"`? Defaults to `"red"`.

`SelectAlpha`:

  Numeric, what level of transparency should be used for the unselected points when `SelectEffect="Transparent"`? This should lie in [0, 1], where 0 is fully transparent and 1 is fully opaque. Defaults to 0.1.

For row-based plots, each point represents a feature, while for column-based plots and heatmaps, each point represents a sample.

Selection information is recorded in the form of brush or lasso objects, which can also be specified:

`BrushData`:

  A list of shiny brush objects, where each brush object is itself a list - see `brushedPoints` for more details. The list should be of length equal to the number of plots.

`LassoData`:

  A list of lasso objects, where each lasso object is itself a list - see `lassoPoints` for more details. The list should be of length equal to the number of plots.

Users should not construct these objects by hand, but instead copy-and-paste the reported code generated by `iSEE`'s code tracker.

It is also possible to store multiple alternative selections for point-based plots through the `MultiSelectHistory` field. This should contain a list of lists of brush or lasso objects containing saved alternative selections for each plot. The outer list should be of length equal to the number of plots. Again, users are advised to copy-and-paste reported code rather than writing these objects by hand.

If the transmitting plot has multiple selections, the current panel can choose between them using:

`SelectMultiType`:

  Character, containing `"Active"`, which uses the active selection on the transmitting panel; `"Union"`, which uses the union of the active selection and all saved selections for the transmitting panel; or `"Saved"`, which uses a single saved selection from the transmitting panel. Defaults to `"Active"`.

`SelectMultiSaved`:

  Integer, specifying the saved selection to use from the transmitting panel when `SelectMultiType` is set to `"Saved"`. Defaults to 0, i.e., no saved selection is used.

### Inter-plot transmission rules

Point selection cannot occur between row-based and column-based plots. This is because each point in a row-based plot is a feature, while each point represents a sample in the other plots. Thus, point selection can only occur between plots of the same point type. The only exception to this rule is the custom panels, which can receive transmissions from both row- and column-based plots – see `customDataPlotDefaults`. This is because they can generate arbitrary plots and are not truly row- or column-based.

### Selection parameters for tables

For row or column statistics tables, the following options apply:

`SelectBoxOpen`:

  Logical, should the point selection parameter box be open upon initialization? Defaults to `FALSE`.

`SelectByPlot`:

  Character, which other plot should be used to select features in the current table? Defaults to `"---"`, which means that no plot is used for point selection.

`SelectMultiType`:

  Character, containing `"Active"`, which uses the active selection on the transmitting panel; `"Union"`, which uses the union of the active selection and all saved selections for the transmitting panel; or `"Saved"`, which uses a single saved selection from the transmitting panel.

`SelectMultiSaved`:

  Integer, specifying the saved selection to use from the transmitting panel when `SelectMultiType` is set to `"Saved"`.

Only row-based plots (i.e., row data and sample assay plots) can be used for selecting points to supply to row statistics tables, for the same reasons described above. Similarly, only column-based plots can be used to select plots to transmit to column statistics tables.

### Author(s)

Aaron Lun, Kevin Rue-Albrecht

### See Also

`redDimPlotDefaults`, `featAssayPlotDefaults`, `colDataPlotDefaults`, `rowDataPlotDefaults`, `sampAssayPlotDefaults`, `heatMapPlotDefaults`, `rowStatTableDefaults`

### Examples

    example(SingleCellExperiment, echo=FALSE) # mock up 'sce'.
    redDimPlotDefaults(sce, n=1)
    rowStatTableDefaults(sce, n=1)

[Package iSEE version 1.4.0 Index]