summarizeSCE: Summarize an assay in a SingleCellExperiment

View source: R/miscFunctions.R

summarizeSCER Documentation

Summarize an assay in a SingleCellExperiment

Description

Creates a table of summary metrics from an input SingleCellExperiment

Usage

summarizeSCE(inSCE, useAssay = NULL, sampleVariableName = NULL)

Arguments

inSCE

Input SingleCellExperiment object.

useAssay

Indicate which assay to summarize. If NULL, then the first assay in inSCE will be used. Default NULL.

sampleVariableName

Variable name in colData denoting which sample each cell belongs to. If NULL, all cells will be assumed to come from the same sample. Default "sample".

Value

A data.frame object of summary metrics.

Examples

data("mouseBrainSubsetSCE")
summarizeSCE(mouseBrainSubsetSCE, sample = NULL)

compbiomed/singleCellTK documentation built on Oct. 27, 2024, 3:26 a.m.