Skip to contents

Get parameter information for a bmm model

Source: R/helpers-parameters.R
parameters.Rd

Returns a data frame with information about the model parameters, including their descriptions, whether they are fixed, their link functions, and optionally their default priors.

Usage

parameters(x, ...)

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

# S3 method for class 'bmmfit'
parameters(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. 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
parameters(sdm(resp_error = "y"))
#> Model:  Signal Discrimination Model (SDM) by Oberauer (2023) 
#> 
#>  parameter description                                        fixed value
#>  mu        Location parameter of the SDM distribution (in ... yes   0    
#>  c         Memory strength parameter of the SDM distribution  no    --   
#>  kappa     Precision parameter of the SDM distribution        no    --   
#>  link    
#>  tan_half
#>  log     
#>  log     

# For an M3 model
parameters(m3(
  resp_cats = c("corr", "other", "npl"),
  num_options = c(1, 4, 5),
  version = "ss"
))
#> Model:  The Multinomial / Memory Measurement Model 
#> 
#>  parameter description                                        fixed value
#>  b         Background activation. Added to each response c... yes   0    
#>  c         Context activation. Added to the item cued to b... no    --   
#>  a         General activation. Added to all items that wer... no    --   
#>  link    
#>  identity
#>  identity
#>  identity