librarySize: Calculate total read counts for each sample.

Description Usage Arguments Value Examples

View source: R/summaries.R

Description

This function is a wrapper function for colSums on the counts assay.

Usage

1
librarySize(object, ..., withDimnames = TRUE)

Arguments

object

PhIPData object

...

arguments passed to colSums

withDimnames

logical; if true, the vector names are the sample names; otherwise the vector is unnamed.

Value

a (named) numeric vector. The length of the vector is equal to the number of samples.

Examples

1
2
3
4
5
example("PhIPData")
librarySize(phip_obj)

## Return an unnamed vector
librarySize(phip_obj, withDimnames = FALSE)

athchen/PhIPData documentation built on Feb. 10, 2022, 1:34 a.m.