rstan (version 2.32.6)

gqs: Draw samples of generated quantities from a Stan model

Description

Draw samples from the generated quantities block of a stanmodel.

Usage

# S4 method for stanmodel
gqs(object, data = list(), draws, 
    seed = sample.int(.Machine$integer.max, size = 1L))

Value

An object of S4 class stanmodel representing the fitted results.

Methods

object

signature(object = "stanmodel") Evaluate the generated quantities block of a Stan program by supplying data and the draws output from a previous Stan program.

Arguments

object

An object of class stanmodel.

data

A named list or environment providing the data for the model or a character vector for all the names of objects used as data. See the Passing data to Stan section in stan.

draws

A matrix of posterior draws, typically created by calling as.matrix on a stanfit.

seed

The seed for random number generation. The default is generated from 1 to the maximum integer supported by R on the machine. When a seed is specified by a number, as.integer will be applied to it. If as.integer produces NA, the seed is generated randomly. The seed can also be specified as a character string of digits, such as "12345", which is converted to integer.

See Also

stanmodel, stanfit, stan

Examples

if (FALSE) {
m <- stan_model(model_code = 'parameters {real y;} model {y ~ normal(0,1);}')
f <- sampling(m, iter = 300)
mc <-
'
parameters {real y;}
generated quantities {real y_rep = normal_rng(y, 1);}
'
m2 <- stan_model(model_code = mc)
f2 <- gqs(m2, draws = as.matrix(f))
f2
}