customStatTableDefaults {iSEE} | R Documentation

## Custom statistics table defaults

### Description

Create default settings for custom statistics table panels in the iSEE interface.

### Usage

    customStatTableDefaults(se, number)

### Arguments

`se` | A SummarizedExperiment object.
`number` | An integer scalar, specifying the maximum number of custom statistics tables that can be added to the interface.

### Details

Data parameters available to custom statistics tables are:

`DataBoxOpen`:

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

`Function`:

  String, which function should be used to generate a data.frame? 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 statistics tables 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 table? Defaults to `"---"`, which means that no plot is used for point selection.

`RowSource`:

  Character, which other plot should transmit feature selections to the current table? Defaults to `"---"`, which means that no plot is used for point selection.

Tables also have an `Search` field indicating what string should be put into the search box. This defaults to an empty string.

### Value

A DataFrame containing default settings for parameters of each of `number` custom statistics table panels.

### Author(s)

Aaron Lun, Kevin Rue-Albrecht

### Examples

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

[Package iSEE version 1.4.0 Index]