Analyse Multiple Models

Fits each model in an mb_models list against the same data, returning an mb_analyses (or mb_meta_analyses if data is a list of data frames).

Usage

# S3 method for class 'mb_models'
analyse(
  x,
  data,
  nchains = getOption("mb.nchains", 3L),
  niters = getOption("mb.niters", 1000L),
  nthin = getOption("mb.thin", NULL),
  parallel = getOption("mb.parallel", FALSE),
  quiet = getOption("mb.quiet", TRUE),
  glance = getOption("mb.glance", TRUE),
  beep = getOption("mb.beep", TRUE),
  seed = sample.int(.Machine$integer.max, 1),
  stan_engine = getOption("mb.stan_engine", character(0)),
  niters_warmup = niters,
  ...
)

Arguments

x

An mb_models list.

data

A data frame, or a named list of data frames for meta-analysis.

nchains

A count of the number of chains (default: 3).

niters

A count of the number of iterations to save per chain (default: 1000).

nthin

A count of the thinning interval.

parallel

A flag indicating whether to perform the analysis in parallel if possible.

quiet

A flag indicating whether to disable messages and warnings, including sampling progress.

glance

A flag indicating whether to print a model summary.

beep

A flag indicating whether to beep on completion of the analysis.

seed

A positive whole number specifying the seed to use. The default is random. This is currently only implemented for Stan models.

stan_engine

A string selecting the Stan engine:

"cmdstan-mcmc": MCMC via cmdstanr::sample().
"cmdstan-pathfinder": pathfinder via cmdstanr::pathfinder().
"cmdstan-variational": variational ADVI via cmdstanr::variational().
"cmdstan-optimize": optimization via cmdstanr::optimize().
"cmdstan-laplace": Laplace approximation via cmdstanr::laplace().

Defaults to character(0). Any value other than the five above (including the empty default) falls back to MCMC via rstan::sampling(). Ignored for JAGS models, which always use rjags.

niters_warmup

A count of the number of warmup iterations. The default is to use the same number of iterations as niters. This is currently only implemented for Stan models.

...

Additional arguments passed to analyse().

Value

An mb_analyses (single data frame) or mb_meta_analyses (list of data frames).

Usage

Arguments

Value

See also