params

Parameter Descriptions for term Functions

internal

Creates, manipulates, queries and repairs vectors of
parameter terms.  Parameter terms are the labels used to reference
values in vectors, matrices and arrays. They represent the names in
coefficient tables and the column names in 'mcmc' and 'mcmc.list'
objects.

Joe Thorley

term

Create, Manipulate and Query Parameter Terms

Kirill Müller

Ayla Pearson

Evan Amies-Galonski

Poisson Consulting 

params function

<dl><dt>x</dt>
<dd>The object.</dd>
<dt>name</dt>
<dd>A string specifying the name of the parameter.</dd>
<dt>...</dt>
<dd>Unused.</dd>
<dt>validate</dt>
<dd>A string specifying the level of the validation.
The possible values in order of increasing strictness
are 'class', 'valid', 'consistent' and 'complete'.</dd>
<dt>repair</dt>
<dd>A flag specifying whether to repair terms.</dd>
<dt>normalize</dt>
<dd>A flag specifying whether to normalize terms.</dd>
<dt>select</dt>
<dd>A character vector of the names of the parameters to include in the subsetted object.</dd>
<dt>value</dt>
<dd>A character vector of the new parameter names.</dd>
<dt>pars</dt>
<dd>A character vector of parameter names.</dd>
<dt>scalar</dt>
<dd>A flag specifying whether to by default return all parameters (NULL), or only scalar parameters (TRUE) or only non-scalar parameters (FALSE).</dd>
<dt>terms</dt>
<dd>A flag specifying whether to return the parameter name
for each term element.</dd>
<dt>incomparables</dt>
<dd>Ignored.</dd></dl>

Arguments

Parameter Descriptions for term Functions — params

<dl>

<dt>x</dt>
<dd>The object.</dd>


<dt>name</dt>
<dd>A string specifying the name of the parameter.</dd>


<dt>...</dt>
<dd>Unused.</dd>


<dt>validate</dt>
<dd>A string specifying the level of the validation.
The possible values in order of increasing strictness
are 'class', 'valid', 'consistent' and 'complete'.</dd>


<dt>repair</dt>
<dd>A flag specifying whether to repair terms.</dd>


<dt>normalize</dt>
<dd>A flag specifying whether to normalize terms.</dd>


<dt>select</dt>
<dd>A character vector of the names of the parameters to include in the subsetted object.</dd>


<dt>value</dt>
<dd>A character vector of the new parameter names.</dd>


<dt>pars</dt>
<dd>A character vector of parameter names.</dd>


<dt>scalar</dt>
<dd>A flag specifying whether to by default return all parameters (NULL), or only scalar parameters (TRUE) or only non-scalar parameters (FALSE).</dd>


<dt>terms</dt>
<dd>A flag specifying whether to return the parameter name
for each term element.</dd>


<dt>incomparables</dt>
<dd>Ignored.</dd>

</dl>