params

internal

Create and manipulate numeric list ('nlist') objects.  An
'nlist' is an S3 list of uniquely named numeric objects.  An numeric
object is an integer or double vector, matrix or array.  An 'nlists'
object is a S3 class list of 'nlist' objects with the same names,
dimensionalities and typeofs.  Numeric list objects are of interest
because they are the raw data inputs for analytic engines such as
'JAGS', 'STAN' and 'TMB'.  Numeric lists objects, which are useful for
storing multiple realizations of of simulated data sets, can be
converted to coda::mcmc and coda::mcmc.list objects.

Joe Thorley

nlist

Lists of Numeric Atomic Objects

Kirill Müller

Nadine Hussein

Ayla Pearson

Poisson Consulting 

params function

<dl><dt>x</dt>
<dd>An object.</dd>
<dt>nthin</dt>
<dd>A positive integer of the thinning rate.</dd>
<dt>...</dt>
<dd>Unused.</dd>
<dt>flesh</dt>
<dd>An atomic vector</dd>
<dt>skeleton</dt>
<dd>An nlist object.</dd>
<dt>scalar</dt>
<dd>A logical scalar specifying whether to include
all parameters (NULL), only scalars (TRUE) or all parameters
except scalars (FALSE).</dd>
<dt>terms</dt>
<dd>A flag specifying whether to return the parameter name
for each term element.</dd>
<dt>chains</dt>
<dd>An integer vector of chains.</dd>
<dt>iters</dt>
<dd>An integer vector of iterations.</dd>
<dt>pars</dt>
<dd>A character vector of parameter names.</dd>
<dt>fun</dt>
<dd>A function that given a numeric vector returns a numeric scalar.</dd>
<dt>nas</dt>
<dd>A flag specifying whether to also fill missing values.</dd>
<dt>parameters</dt>
<dd>A character vector (or NULL) of the parameters to subset by.</dd>
<dt>iterations</dt>
<dd>An integer vector (or NULL) of the iterations to subset by.</dd>
<dt>simplify</dt>
<dd>A flag specifying whether to drop the sd and zscore
columns. <code>simplify = FALSE</code> is deprecated.</dd>
<dt>directional_information</dt>
<dd>A flag specifying whether the svalue column
should be calculated using <code>extras::directional_information()</code> instead of
<code>extras::svalue()</code>.
The default value will change from <code>FALSE</code> to <code>TRUE</code> in a future release;
set the argument explicitly to avoid the deprecation warning.</dd>
<dt>silent</dt>
<dd>A flag specifying whether to suppress warning messages.</dd>
<dt>by_chain</dt>
<dd>A flag specifying whether to aggregate by chains.</dd></dl>

Arguments

Parameter Descriptions — params

<dl>

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


<dt>nthin</dt>
<dd>A positive integer of the thinning rate.</dd>


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


<dt>flesh</dt>
<dd>An atomic vector</dd>


<dt>skeleton</dt>
<dd>An nlist object.</dd>


<dt>scalar</dt>
<dd>A logical scalar specifying whether to include
all parameters (NULL), only scalars (TRUE) or all parameters
except scalars (FALSE).</dd>


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


<dt>chains</dt>
<dd>An integer vector of chains.</dd>


<dt>iters</dt>
<dd>An integer vector of iterations.</dd>


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


<dt>fun</dt>
<dd>A function that given a numeric vector returns a numeric scalar.</dd>


<dt>nas</dt>
<dd>A flag specifying whether to also fill missing values.</dd>


<dt>parameters</dt>
<dd>A character vector (or NULL) of the parameters to subset by.</dd>


<dt>iterations</dt>
<dd>An integer vector (or NULL) of the iterations to subset by.</dd>


<dt>simplify</dt>
<dd>A flag specifying whether to drop the sd and zscore
columns. <code>simplify = FALSE</code> is deprecated.</dd>


<dt>directional_information</dt>
<dd>A flag specifying whether the svalue column
should be calculated using <code>extras::directional_information()</code> instead of
<code>extras::svalue()</code>.
The default value will change from <code>FALSE</code> to <code>TRUE</code> in a future release;
set the argument explicitly to avoid the deprecation warning.</dd>


<dt>silent</dt>
<dd>A flag specifying whether to suppress warning messages.</dd>


<dt>by_chain</dt>
<dd>A flag specifying whether to aggregate by chains.</dd>

</dl>

Parameter Descriptions