BASiCS_EffectiveSize: Calculate effective sample size for BASiCS_Chain parameters

Description Usage Arguments Value Examples

View source: R/BASiCS_EffectiveSize.R

Description

A function to calculate effective sample size BASiCS_Chain objects.

Usage

1
2
3
BASiCS_EffectiveSize(object, Parameter, na.rm = TRUE)

BASiCS_effectiveSize(...)

Arguments

object

an object of class BASiCS_Chain.

Parameter

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

na.rm

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

...

Unused.

Value

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

Examples

1
2

BASiCS documentation built on April 16, 2021, 6 p.m.