extractControlElement

Extract named elements from MCMC sampler control list

A system for writing hierarchical statistical models largely
compatible with 'BUGS' and 'JAGS', writing nimbleFunctions to operate models
and do basic R-style math, and compiling both models and nimbleFunctions via
custom-generated C++. 'NIMBLE' includes default methods for MCMC, Laplace
Approximation, Monte Carlo Expectation Maximization, and some other tools.
The nimbleFunction system makes it easy to do things like implement new MCMC
samplers from R, customize the assignment of samplers to different parts of
a model from R, and compile the new samplers automatically via C++ alongside
the samplers 'NIMBLE' provides. 'NIMBLE' extends the 'BUGS'/'JAGS' language
by making it extensible: New distributions and functions can be added,
including as calls to external compiled code. Although most people think
of MCMC as the main goal of the 'BUGS'/'JAGS' language for writing models,
one can use 'NIMBLE' for writing arbitrary other kinds of model-generic
algorithms as well. A full User Manual is available at <https://r-nimble.org>.

Christopher Paciorek

nimble

MCMC, Particle Filtering, and Programmable Hierarchical Modeling

Perry de Valpine

Daniel Turek

Nick Michaud

Cliff Anderson-Bergman

Fritz Obermeyer

Claudia Wehrhahn Cortes

Abel Rodríguez

Duncan Temple Lang

Wei Zhang

Sally Paganin

Joshua Hug

Paul van Dam-Bates

Jagadish Babu

Lauren Ponisio

Peter Sujan

extractControlElement function

<dl><dt>controlList</dt>
<dd>control list object, which is passed as an argument to all MCMC sampler setup functions.</dd>
<dt>elementName</dt>
<dd>character string, giving the name of the element to be extracted from the control list.</dd>
<dt>defaultValue</dt>
<dd>default value of the control list element, giving the value to be used when the <code>elementName</code> does not exactly match the name of an element in the <code>controlList</code>.</dd>
<dt>error</dt>
<dd>character string, giving the error message to be printed if no <code>defaultValue</code> is provided and <code>elementName</code> does not match the name of an element in the <code>controlList</code>.</dd></dl>

Arguments

Author

Extract named elements from MCMC sampler control list — extractControlElement

<dl>

<dt>controlList</dt>
<dd>control list object, which is passed as an argument to all MCMC sampler setup functions.</dd>


<dt>elementName</dt>
<dd>character string, giving the name of the element to be extracted from the control list.</dd>


<dt>defaultValue</dt>
<dd>default value of the control list element, giving the value to be used when the <code>elementName</code> does not exactly match the name of an element in the <code>controlList</code>.</dd>


<dt>error</dt>
<dd>character string, giving the error message to be printed if no <code>defaultValue</code> is provided and <code>elementName</code> does not match the name of an element in the <code>controlList</code>.</dd>

</dl>

Extract named elements from MCMC sampler control list

extractControlElement: Extract named elements from MCMC sampler control list

Description

Usage

Value

Arguments

Author