parameter_info: Get parameter information for a bmm model

In bmm: Easy and Accessible Bayesian Measurement Models Using 'brms'

Get parameter information for a bmm model

Description

Returns a data frame with information about the model parameters: their descriptions, whether they are fixed (and to which value), and their link functions. Use prior_info() for the priors of a fitted model.

Usage

parameter_info(x, ...)

## S3 method for class 'bmmodel'
parameter_info(x, formula = NULL, ...)

## S3 method for class 'bmmfit'
parameter_info(x, ...)

Arguments

x	A bmmodel object (e.g., sdm(resp_error = "y")) or a bmmfit object (a fitted model returned by bmm).
...	Additional arguments (currently unused).
formula	An optional bmmformula object. Only relevant for M3 custom models, where additional parameters are discovered from the formula. Only activation symbols that have their own formula are listed; without data, any other symbol is read as a data column. Ignored for all other models.

Value

A data frame of class bmm_parameters with one row per parameter and columns: parameter, description, fixed, value, and link.

Examples

# For an unfitted model
parameter_info(sdm(resp_error = "y"))

# For an M3 model
parameter_info(m3(
  resp_cats = c("corr", "other", "npl"),
  num_options = c(1, 4, 5),
  version = "ss"
))

bmm documentation built on Oct. 16, 2026, 9:08 a.m.