scExperiment {SCArray}

R Documentation

Get a SummarizedExperiment

Description

Gets an instance of SingleCellExperiment or SummarizedExperiment.

Usage

scExperiment(gdsfile, sce=TRUE, use.names=TRUE, load.row=TRUE, load.col=TRUE)

Arguments

gdsfile	character for a file name, or a single-cell GDS object with class SCArrayFileClass
sce	if TRUE, return an instance of SingleCellExperiment, otherwise an instance of SummarizedExperiment
use.names	if TRUE, load dimnames from 'feature.id' and 'sample.id'
load.row	TRUE for loading rowData from the gds node "feature.data" in gdsfile
load.col	TRUE for loading colData from the gds node "sample.data" in gdsfile

Value

Return an instance of SingleCellExperiment or SummarizedExperiment.

Author(s)

Xiuwen Zheng

See Also

scOpen, scClose

Examples

# a GDS file for SingleCellExperiment
fn <- system.file("extdata", "LaMannoBrainData.gds", package="SCArray")

sce <- scExperiment(fn)
sce

---