getParam: Get value of a parameter of a stochastic node in a model

View source: R/nimbleFunction_Rexecution.R

getParamR Documentation

Get value of a parameter of a stochastic node in a model

Description

Get the value of a parameter for any single stochastic node in a model.

Usage

getParam(model, node, param, nodeFunctionIndex)

Arguments

model

A NIMBLE model object

node

The name of a stochastic node in the model

param

The name of a parameter for the node

nodeFunctionIndex

For internal NIMBLE use only

Details

Standard usage is as a method of a model, in the form model$getParam(node, param), but the usage as a simple function with the model as the first argument as above is also allowed.

For example, suppose node 'x[1:5]' follows a multivariate normal distribution (dmnorm) in a model declared by BUGS code. model$getParam('x[1:5]', 'mean') would return the current value of the mean parameter (which may be determined from other nodes). The parameter requested does not have to be part of the parameterization used to declare the node. Rather, it can be any parameter known to the distribution. For example, one can request the scale or rate parameter of a gamma distribution, regardless of which one was used to declare the node.


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