redDimPlotDefaults {iSEE} | R Documentation

## Reduced dimension plot defaults

### Description

Create default settings for reduced dimension plot panels in the iSEE interface.

### Usage

    redDimPlotDefaults(se, number)

### Arguments

`se` | A SummarizedExperiment object.
`number` | An integer scalar, specifying the maximum number of reduced dimension plots that can be added to the interface.

### Details

Parameters available to reduced dimension plots are:

`Type`:

  Integer, which entry of `reducedDims(se)` should be shown? Defaults to 1, i.e., the first entry. Alternatively, a string can be supplied containing the name of the reduced dimension field, if `reducedDims(se)` has names.

`XAxis`:

  Integer, which component should be shown on the x-axis? Defaults to 1.

`YAxis`:

  Integer, which component should be shown on the y-axis? Defaults to 2.

All column-based parameters described in `?"iSEE point parameters"` are applicable. All plot-based parameters described in `?"iSEE selection parameters"` are applicable.

### Value

A DataFrame containing default settings for parameters of each of `number` reduced dimension panels.

### Author(s)

Aaron Lun

### See Also

`?"iSEE point parameters"`, `?"iSEE selection parameters"`

### Examples

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

[Package iSEE version 1.6.1 Index]