effectiveLibSizes: Effective Library Sizes

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/effectiveLibSizes.R

Description

Extract effective (normalized) library sizes.

Usage

1
2
## Default S3 method:
effectiveLibSizes(y, log = FALSE, ...)

Arguments

y

a object of class DGEList, DGEGLM or DGELRT. Alternatively a numeric matrix or an object that can be coerced to a numeric matrix.

log

logical, if TRUE then the library sizes are return on the natural log scale.

...

other arguments are not currently used.

Details

This function extracts normalized library sizes, equal to the original library sizes multiplied by the corresponding normalization factors, from an edgeR data object or fitted model object.

If the object contains a row-specific offsets (i.e., a non-sparse matrix of offsets), then the offsets for the first row are returned.

Value

A numeric matrix of effective (normalized) library sizes. If log=TRUE, then natural log values are returned, equal to library size offsets for a NB log-linear model.

Author(s)

Gordon Smyth

See Also

calcNormFactors

Examples

1
2
3
4
5
ngenes <- 100
nsamples <- 4
y <- DGEList(counts=matrix(rnbinom(ngenes*nsamples,size=1,mu=10),ngenes,nsamples))
y <- calcNormFactors(y)
data.frame(y$samples, eff.lib.size=effectiveLibSizes(y))

hiraksarkar/edgeR_fork documentation built on Dec. 20, 2021, 3:52 p.m.