normalizeNbpseq: Normalization based on the NBPSeq package

View source: R/norm.R

normalizeNbpseqR Documentation

Normalization based on the NBPSeq package

Description

This function is a wrapper over DESeq normalization. It accepts a matrix of gene counts (e.g. produced by importing an externally generated table of counts to the main metaseqr2 pipeline).

Usage

    normalizeNbpseq(geneCounts, sampleList,
        normArgs = NULL, libsizeList = NULL,
        output = c("matrix", "native"))

Arguments

geneCounts

a table where each row represents a gene and each column a sample. Each cell contains the read counts for each gene and sample. Such a table can be produced outside metaseqr2 and is imported during the basic metaseqr2 workflow.

sampleList

the list containing condition names and the samples under each condition.

normArgs

a list of NBPSeq normalization parameters. See the result of getDefaults("normalization", "nbpseq") for an example and how you can modify it.

libsizeList

an optional named list where names represent samples (MUST be the same as the samples in sampleList) and members are the library sizes (the sequencing depth) for each sample. If not provided, the default is the column sums of the geneCounts matrix.

output

the class of the output object. It can be "matrix" (default) for versatility with other tools or "native" for the NBPSeq native S4 object (a specific list). In the latter case it should be handled with suitable NBPSeq methods.

Value

A matrix with normalized counts or a list with the normalized counts and other NBPSeq specific parameters.

Author(s)

Panagiotis Moulos

Examples

dataMatrix <- metaseqR2:::exampleCountData(2000)
sampleList <- list(A=c("A1","A2"),B=c("B1","B2","B3"))
diagplotBoxplot(dataMatrix,sampleList)

normDataMatrix <- normalizeNbpseq(dataMatrix,sampleList)
diagplotBoxplot(normDataMatrix,sampleList)

pmoulos/metaseqR2 documentation built on May 20, 2024, 5:48 a.m.