as.array: Create array, matrix, or data.frame objects from samples in a
Description
The samples (without warmup) included in a array, matrix, or data.frame.
Methods are also provided for checking and setting names and dimnames.Usage
# S3 method for stanfit
as.array(x, …)
# S3 method for stanfit
as.matrix(x, …)
# S3 method for stanfit
as.data.frame(x, …)
# S3 method for stanfit
is.array(x)
# S3 method for stanfit
dim(x)
# S3 method for stanfit
dimnames(x)
# S3 method for stanfit
names(x)
# S3 method for stanfit
names(x) <- value
Arguments
…
Additional parameters that can be passed to extract
for extracting samples from x. For now, pars
is the only additional parameter supported.
value
For the names replacement method, a character vector to
set/replace the parameter names in x.
Value
as.array, as.matrix, and as.data.frame return an array,
matrix, and data.frame, respectively. dim and dimnames return the dim and dimnames of the
array object that could be created, while names returns the third
element of the dimnames, which are the names of the margins of the
posterior distribution. The names assignment method allows for
assigning more interpretable names to them. is.array returns TRUE for stanfit objects that include
samples; otherwise FALSE. When the stanfit object does not contain samples, empty objects
are returned from as.array, as.matrix, as.data.frame,
dim, dimnames, and names.Details
as.array and as.matrix can be applied to a stanfit
object to coerce the samples without warmup to array or matrix.
The as.data.frame method first calls as.matrix and then coerces
this matrix to a data.frame. The array has three named dimensions: iterations, chains, parameters.
For as.matrix, all chains are combined, leaving a matrix of iterations
by parameters.See Also
S4 class extract