Skip to contents

This function returns a list of MCMC settings to pass to the $sample() function to fit the model. The default settings are specified for production-level runs. All input arguments to $sample() are configurable by the user. See $sample() documentation for details of the available arguments.

Usage

get_mcmc_options(
  iter_warmup = 750,
  iter_sampling = 500,
  seed = NULL,
  chains = 4,
  adapt_delta = 0.95,
  max_treedepth = 12
)

Arguments

iter_warmup

integer indicating the number of warm-up iterations, default is 750.

iter_sampling

integer indicating the number of sampling iterations, default is 500.

seed

integer, A seed for the (P)RNG to pass to CmdStan. In the case of multi-chain sampling the single seed will automatically be augmented by the the run (chain) ID so that each chain uses a different seed. Default is NULL.

chains

integer indicating the number of MCMC chains to run, default is 4.

adapt_delta

float between 0 and 1 indicating the average acceptance probability, default is 0.95.

max_treedepth

integer indicating the maximum tree depth of the sampler, default is 12.

Value

A list of MCMC settings with the values given by the function. arguments