brms (version 1.10.2)

fixef.brmsfit: Extract Population-Level Estimates

Description

Extract the population-level ('fixed') effects from a brmsfit object.

Usage

# S3 method for brmsfit
fixef(object, summary = TRUE, robust = FALSE,
  probs = c(0.025, 0.975), old = FALSE, estimate = "mean", ...)

Arguments

object

An object of class brmsfit.

summary

Should summary statistics (i.e. means, sds, and 95% intervals) be returned instead of the raw values? Default is TRUE.

robust

If FALSE (the default) the mean is used as the measure of central tendency and the standard deviation as the measure of variability. If TRUE, the median and the median absolute deivation (MAD) are applied instead. Only used if summary is TRUE.

probs

The percentiles to be computed by the quantile function. Only used if summary is TRUE.

old

Logical; indicates if the old implementation of this method (prior to version 1.7.0) should be used. Defaults to FALSE.

estimate

(Deprecated) A character vector specifying which coefficients (e.g., "mean", "median", "sd", or "quantile") should be calculated for the population-level effects. Only used if old is TRUE.

...

Further arguments to be passed to the functions specified in estimate.

Value

If summary is TRUE, a matrix with one row per population-level effect and one column per calculated estimate. If summary is FALSE, a matrix with one row per posterior sample and one column per population-level effect.

Examples

# NOT RUN {
fit <- brm(time | cens(censored) ~ age + sex + disease, 
           data = kidney, family = "exponential")
fixef(fit)
# }
# NOT RUN {
# }