SCE internals {SingleCellExperiment}R Documentation

SCE internal methods

Description

Methods to get or set internal fields from the SingleCellExperiment class.

Usage

## S4 method for signature 'SingleCellExperiment'
int_elementMetadata(x)

## S4 replacement method for signature 'SingleCellExperiment'
int_elementMetadata(x) <- value

## S4 method for signature 'SingleCellExperiment'
int_colData(x)

## S4 replacement method for signature 'SingleCellExperiment'
int_colData(x) <- value

## S4 method for signature 'SingleCellExperiment'
int_metadata(x)

## S4 replacement method for signature 'SingleCellExperiment'
int_metadata(x) <- value

Arguments

x

A SingleCellExperiment object.

value

For int_elementMetadata, a DataFrame with number of rows equal to nrow(x).

For int_colData, a DataFrame with number of rows equal to ncol(x).

For int_metadata, a list.

Details

These functions are intended for package developers who want to add protected fields to a SingleCellExperiment. They should not be used by ordinary users of the SingleCellExperiment package.

Package developers intending to use these methods should read the development vignette for instructions.

Value

A SingleCellExperiment object equivalent to x but with modified internal fields.

See Also

SingleCellExperiment

Examples

example(SingleCellExperiment, echo=FALSE) # Using the class example
int_metadata(sce)$whee <- 1

[Package SingleCellExperiment version 1.4.1 Index]