brms (version 2.1.0)

prior_samples.brmsfit: Extract prior samples

Description

Extract prior samples of specified parameters

Usage

# S3 method for brmsfit
prior_samples(x, pars = NA, ...)
prior_samples(x, pars = NA, ...)

Arguments

x

An R object typically of class brmsfit

pars

Names of parameters for which prior samples should be returned, as given by a character vector or regular expressions. By default, all prior samples are extracted

...

Currently ignored

Value

A data frame containing the prior samples.

Details

To make use of this function, the model must contain samples of prior distributions. This can be ensured by setting sample_prior = TRUE in function brm. Currently there are methods for brmsfit objects.

Examples

# NOT RUN {
fit <- brm(rating ~ treat + period + carry + (1|subject), 
           data = inhaler, family = "cumulative", 
           prior = set_prior("normal(0,2)", class = "b"), 
           sample_prior = TRUE)

# extract all prior samples
samples1 <- prior_samples(fit)
head(samples1)

# extract prior samples for the population-level effects of 'treat'
samples2 <- posterior_samples(fit, "b_treat")
head(samples2)
# }
# NOT RUN {
# }