example_draws: Example 'draws' objects

View source: R/example_draws.R

example_drawsR Documentation

Example draws objects

Description

Objects for use in examples, vignettes, and tests.

Usage

example_draws(example = "eight_schools")

Arguments

example

(string) The name of the example draws object. See Details for available options.

Details

The following example draws objects are available.

eight_schools: A draws_array object with 100 iterations from each of 4 Markov chains obtained by fitting the eight schools model described in Gelman et al. (2013) with Stan. The variables are:

  • mu: Overall mean of the eight schools

  • tau: Standard deviation between schools

  • theta: Individual means of each of the eight schools

multi_normal: A draws_array object with 100 iterations from each of the 4 Markov chains obtained by fitting a 3-dimensional multivariate normal model to 100 simulated observations. The variables are:

  • mu: Mean parameter vector of length 3

  • Sigma: Covariance matrix of dimension 3 x 3

Value

A draws object.

Note

These objects are only intended to be used in demonstrations and tests. They contain fewer iterations and chains than recommended for performing actual inference.

References

Andrew Gelman, John B. Carlin, Hal S. Stern, David B. Dunson, Aki Vehtari and Donald B. Rubin (2013). Bayesian Data Analysis, Third Edition. Chapman and Hall/CRC.

Examples

draws_eight_schools <- example_draws("eight_schools")
summarise_draws(draws_eight_schools)

draws_multi_normal <- example_draws("multi_normal")
summarise_draws(draws_multi_normal)


posterior documentation built on Nov. 2, 2023, 5:56 p.m.