Effective sample size

Returns the effective sample size (ESS) of the selected parameter type. Full range of possible samples manipulations described in get_pars.

Usage

# S3 method for class 'emc'
ess_summary(
  emc,
  selection = "mu",
  stat = "min",
  stat_only = FALSE,
  digits = 1,
  ...
)

ess_summary(emc, ...)

Arguments

emc

An emc object

selection

A Character vector. Indicates which parameter types to check (e.g., alpha, mu, sigma2, correlation).

stat

A string. Should correspond to a function that can be applied to a vector, which will be performed on the vector/rows or columns of the matrix of the parameters

stat_only

Boolean. If TRUE will only return the result of the applied stat function, otherwise returns both the stat result and the result of the function on all parameters.

digits

Integer. How many digits to round the output to

...

Optional additional arguments that can be passed to get_pars

Value

A matrix or vector of ESS values for the selected parameter type.

Examples

ess_summary(samples_LNR, selection = "alpha")
#>        as1t  bd6t  bl1t   min
#> m      56.8 177.7 216.7  56.8
#> m_lMd 116.0 131.8 185.1 116.0
#> s      69.3 195.7 173.2  69.3
#> t0     53.1 188.1 177.1  53.1
#> min    53.1 131.8 173.2  53.1