miscellaneous: Miscellaneous SingleCellExperiment methods

In LTLA/SingleCellExperiment: S4 Classes for Single Cell Data

Miscellaneous SingleCellExperiment methods

Description

Miscellaneous methods for the SingleCellExperiment class that do not fit in any other documentation category.

Available methods

In the following code snippets, x and object are SingleCellExperiment objects.

show(object):

Print a message to screen describing the contents of object.

objectVersion(x):

Return the version of the package with which x was constructed.

sizeFactors(object):

Return a numeric vector of size factors of length equal to ncol(object). If no size factors are available in object, return NULL instead.

sizeFactors(object) <- value:

Replace the size factors with value, usually expected to be a numeric vector or vector-like object. Alternatively, value can be NULL in which case any size factors in object are removed.

Author(s)

Aaron Lun

See Also

updateObject, where objectVersion is used.

Examples

example(SingleCellExperiment, echo=FALSE) # Using the class example

show(sce)

objectVersion(sce)

# Setting/getting size factors.
sizeFactors(sce) <- runif(ncol(sce))
sizeFactors(sce)

sizeFactors(sce) <- NULL
sizeFactors(sce)

LTLA/SingleCellExperiment documentation built on Nov. 12, 2024, 6:58 a.m.