librarySize {PhIPData}R Documentation

Calculate total read counts for each sample.

Description

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

Usage

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

example("PhIPData")
librarySize(phip_obj)

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

[Package PhIPData version 1.1.2 Index]