BASiCS_effectiveSize {BASiCS}R Documentation

Calculate effective sample size for BASiCS_Chain parameters

Description

A wrapper of coda::effectiveSize to be used with BASiCS_Chain objects.

Usage

BASiCS_effectiveSize(object, Param, na.rm = TRUE)

Arguments

object

an object of class BASiCS_Chain.

Param

The parameter to use to calculate effectiveSize. Possible values: 'mu', 'delta', 'phi', 's', 'nu', 'theta', 'beta', 'sigma2' and 'epsilon'.

na.rm

Remove NA values before calculating effectiveSize. Only relevant when Param = "epsilon" (genes with very low expression are excluding when infering the mean/over-dispersion trend. Default: na.rm = TRUE.

Value

A vector with effective sample sizes for all the elements of Param

Examples


data(ChainSC)
BASiCS_effectiveSize(ChainSC, Param = "mu")


[Package BASiCS version 1.6.0 Index]