extractControlElement: Extract named elements from MCMC sampler control list

View source: R/MCMC_utils.R

extractControlElementR Documentation

Extract named elements from MCMC sampler control list

Description

Extract named elements from MCMC sampler control list

Usage

extractControlElement(controlList, elementName, defaultValue, error)

Arguments

controlList

control list object, which is passed as an argument to all MCMC sampler setup functions.

elementName

character string, giving the name of the element to be extracted from the control list.

defaultValue

default value of the control list element, giving the value to be used when the elementName does not exactly match the name of an element in the controlList.

error

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

Value

The element of controlList whose name matches elementName. If no controlList name matches elementName, then defaultValue is returned.

Author(s)

Daniel Turek


nimble documentation built on March 18, 2022, 8:03 p.m.