cellToSample: Cell-to-sample mappings

cellToSampleR Documentation

Cell-to-sample mappings

Description

Cell-to-sample mappings

Usage

cellToSample(object, ...)

## S4 method for signature 'SingleCellExperiment'
cellToSample(object, return = c("factor", "DFrame"))

Arguments

object

Object.

return

character(1). Return type. Uses match.arg() internally and defaults to the first argument in the character vector.

...

Additional arguments.

Details

Sample identifiers must be defined in sampleId column in colData().

Value

  • "factor": Named factor containing the samples as the levels and cell identifiers as the names.

  • "DFrame": S4 data frame containing sampleId column and cell identifiers as the row names.

Note

Updated 2023-09-26.

Examples

data(SingleCellExperiment_splatter, package = "AcidTest")

## SingleCellExperiment ====
object <- SingleCellExperiment_splatter
c2s <- cellToSample(object)
table(c2s)

acidgenomics/r-acidsinglecell documentation built on March 30, 2024, 5:39 a.m.