Priors used in a fit — prior

On draws from frmtmb.sample::frm_sample() this reports the priors the sampler applied, which on the formula interface includes the brms default priors it chose (see the Default priors section of that function).

Usage

prior_summary(object, ...)

# S3 method for class 'frmtmb_fit'
prior_summary(object, ...)

Arguments

object: A frmtmb_fit, or a frmtmb_draws from frmtmb.sample::frm_sample().
...: Refused: an argument the method does not have is an error naming it, rather than silently changing nothing.

Value

The frmtmb_priorlist the fit was penalized with, or that the sampler used, or (invisibly) NULL when there were none.

Examples

set.seed(1)
dd <- data.frame(x = rnorm(100), g = factor(rep(1:10, 10)))
dd$y <- rnorm(100, 1 + 0.5 * dd$x + rnorm(10, 0, 0.8)[dd$g], 1)

# what was actually applied, after set_prior() was matched to the
# coefficients of this design
fit <- frm(bf(y ~ x + (1 | g)) + gaussian(), data = dd,
           prior = set_prior("normal(0, 1)", class = "b") +
                    set_prior("exponential(1)", class = "sd"))
prior_summary(fit)
#>           prior class coef group resp dpar nlpar   lb   ub source
#>    normal(0, 1)     b                            <NA> <NA>   user
#>  exponential(1)    sd                            <NA> <NA>   user

# a plain maximum-likelihood fit reports that it had none
prior_summary(frm(bf(y ~ x + (1 | g)) + gaussian(), data = dd))
#> No priors were set (plain maximum likelihood).