mcmcOptions: mcmcOptions object constructor.

View source: R/class_mcmcOptions.R

mcmcOptionsR Documentation

mcmcOptions object constructor.

Description

Creates a new instance of a 'mcmcOptions' object

Usage

mcmcOptions(
  fname = "Config_MCMC.txt",
  result.fname = "Results_MCMC.txt",
  nAdapt = 100,
  nCycles = 100,
  minMoveRate = 0.1,
  maxMoveRate = 0.5,
  downMult = 0.9,
  upMult = 1.1,
  multFactor = 0.1,
  manualMode = FALSE,
  thetaStd = 9999,
  gammaStd = list(9999)
)

Arguments

fname

Character, configuration file name.

result.fname

Character, result file name.

nAdapt

Integer, adaptation period: jump sizes are increased/decreased every Nadapt iterations to comply with the desired moving rates.

nCycles

Integer, number of adaptation cycles (total number of iterations is hence Nadapt * Ncycles).

minMoveRate

Numeric in (0;1), lower bound for the desired move rate interval.

maxMoveRate

Numeric in (0;1), upper bound for the desired move rate interval.

downMult

Numeric in (0:1), multiplication factor used to decrease jump size when move rate is too low.

upMult

Numeric (>1, avoid 1/dowMult) multiplication factor used to increase jump size when move rate is too high.

multFactor

Numeric >0, multiplicative factor to set initial jump standard deviations to multFactor*|initValue| (AUTO mode).

manualMode

logical, should jump standard deviations be entered manually?

thetaStd

Numeric vector (>0), jump standard deviations for model parameters theta (MANUAL mode).

gammaStd

list of numeric vectors (>0), size = number of output variables of the model. Jump standard deviations for structural error parameters gamma of each output variable (MANUAL mode).

Value

An object of class 'mcmcOptions'.

Examples

m <- mcmcOptions()

BaM-tools/RBaM documentation built on April 11, 2025, 10:01 p.m.