ExperimentSubset {ExperimentSubset}R Documentation

ExperimentSubset constructor

Description

This constructor function is used to setup the ExperimentSubset object, either through manually specifying the assays, rowData, colData or directly by passing either a SingleCellExperiment or SummarizedExperiment objects or objects inherited by these classes. A subset can also be directly created by passing a named list to the subset parameter. This named list should have parameter values named as subsetName, rows, cols and parentAssay.

Usage

ExperimentSubset(
  x,
  subset = list(subsetName = NA, rows = NA, cols = NA, parentAssay = NA)
)

Arguments

x

An experiment object if direct conversion is required or a list of slots to pass onto SingleCellExperiment constructor to generate experiment object from general data.

subset

A named list if a subset should be created from within the constructor. Named parameters in this list should be subsetName, rows, cols and parentAssay.

Value

A ExperimentSubset object.

Examples

data(sce_chcl, package = "scds")
es <- ExperimentSubset(sce_chcl)
es
[Package ExperimentSubset version 1.2.0 Index]