colDataPlotDefaults {iSEE} | R Documentation

## Column data plot defaults

### Description

Create default settings for column data plot panels in the iSEE interface.

### Usage

    colDataPlotDefaults(se, number)

### Arguments

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

### Details

Parameters available to column data plots are:

`YAxis`:

  Character, which column of `colData(se)` should be shown on the y-axis? Defaults to the first entry of `colData(se)`.

`XAxis`:

  Character, what type of variable should be shown on the x-axis? Defaults to `"None"`, but can also be `"Column data"`.

`XAxisColData`:

  Character, which column of `colData(se)` should be shown on the x-axis if `XAxis="Column data"`? Defaults to the first entry of `colData(se)`.

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` column data panels.

### Author(s)

Aaron Lun

### See Also

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

### Examples

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

[Package iSEE version 1.6.1 Index]