computeInfRV: Compute inferential relative variance (InfRV)

Description Usage Arguments Value

View source: R/helper.R

Description

InfRV is used the Swish publication for visualization. This function provides computation of the mean InfRV, a simple statistic that measures inferential uncertainty. Note that InfRV is not used in the swish statistical method at all, it is just for visualization. See function code for details.

Usage

1
computeInfRV(y, pc = 5, shift = 0.01, meanVariance)

Arguments

y

a SummarizedExperiment

pc

a pseudocount parameter for the denominator

shift

a final shift parameter

meanVariance

logical, use pre-computed inferential mean and variance assays instead of counts and computed variance from infReps. If missing, will use pre-computed mean and variance when present.

Value

a SummarizedExperiment with meanInfRV in the metadata columns


fishpond documentation built on Nov. 8, 2020, 7:54 p.m.