makeParamInfo: Make an object of information about a model-parameter pairing...

View source: R/nimbleFunction_Rexecution.R

makeParamInfoR Documentation

Make an object of information about a model-parameter pairing for getParam. Used internally

Description

Creates a simple getParam_info object, which has a list with a paramID and a type

Usage

makeParamInfo(model, nodes, param, vector = FALSE)

Arguments

model

A model such as returned by nimbleModel.

nodes

A character string naming one one or more stochastic nodes, such as "mu", "c('mu', 'beta[2]')", or "eta[1:3, 2]". getParam only works for one node at a time, but if it is indexed (nodes[i]), then makeParamInfo sets up the information for the entire vector nodes. The processing pathway is used by the NIMBLE compiler.

param

A character string naming a parameter of the distribution followed by node, such as "mean", "rate", "lambda", or whatever parameter names are relevant for the distribution of the node.

vector

A logical indicating whether nodes should definitely be treated as a vector in compiled code, even if it has length = 1. For type consistency, the compiler needs this option. If nodes has length > 1, this argument is ignored.

Details

This is used internally by getParam. It is not intended for direct use by a user or even a nimbleFunction programmer.


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