set.run.list: Create a List of Parameters For MCMC Procedure

Description Usage Arguments Value Examples

View source: R/setup_run_fxns.R

Description

Pack various parameters related to the MCMC procedure and plotting into a single list. These include: The number of MCMC chains, the number of MCMC steps in each chain, the number of instances saved for each chain and the device name for plotting the results.

Usage

1
2
set.run.list(nreal = 1, nMCMC = 1e+05, nlines = NULL, device = "pdf",
  subDir = "output", plot = 1)

Arguments

nreal

Integer - The number of MCMC chains (default is 1)

nMCMC

Integer - the number of steps in each MCMC chain (default is 1e5)

nlines

Integer - the number of instances saved for the history of the chain (default is to save every 100 steps and not to exceed 1e4)

device

String - the device name for plotting. Default is 'pdf' but we also support 'png'

subDir

String - the sub-directory name for all output files of the run. Default it 'output'

plot

Character - TRUE, FALSE or EXTERNAL allows users to use their own plotting routines for the results (can also use 0, 1 and 2)

Value

A list packed with these parameters

Examples

1
2
set.run.list{nreal = 1, nMCMC = 1e+05, nlines = 1e3, device = 'pdf'}
set.run.list{nreal = 3, nMCMC = 5e+06, nlines = 1e4, device = 'pdf'}

predsci/DICE documentation built on Aug. 9, 2019, 9:41 a.m.