AntMAN (version 1.1.0)

AM_mcmc_parameters: MCMC Parameters

Description

This function generates an MCMC parameters list to be used as mcmc_parameters argument within AM_mcmc_fit.

Usage

AM_mcmc_parameters(
  niter = 5000,
  burnin = 2500,
  thin = 1,
  verbose = 1,
  output = c("CI", "K"),
  parallel = TRUE,
  output_dir = NULL
)

Arguments

niter

Total number of MCMC iterations to be carried out.

burnin

Number of iterations to be considered as burn-in. Samples from this burn-in period are discarded.

thin

Thinning rate. This argument specifies how often a draw from the posterior distribution is stored after burnin, i.e. one every -th samples is saved. Therefore, the toral number of MCMC samples saved is (niter -burnin)/thin. If thin =1, then AntMAN stores every iteration.

verbose

A value from 0 to 4, that specifies the desired level of verbosity (0:None, 1:Warnings, 2:Debug, 3:Extras).

output

A list of parameters output to return.

parallel

Some of the algorithms can be run in parallel using OpenMP. When set to True, this parameter triggers the parallelism.

output_dir

Path to an output dir, where to store all the outputs.

Value

An AM_mcmc_configuration Object. This is a list to be used as mcmc_parameters argument with AM_mcmc_fit.

Examples

# NOT RUN {
AM_mcmc_parameters (niter=1000, burnin=10000, thin=50)
AM_mcmc_parameters (niter=1000, burnin=10000, thin=50, output=c("CI","W","TAU"))
# }