Skip to contents

List Registered HBSAE Models

Source: R/register-model.R
list_hbsae_models.Rd

Returns the keys of all model specs currently registered in the hbsaems model registry. Built-in models ("gaussian", "beta", "binomial", "lognormal", etc.) are always included; user-registered models appear in addition.

Usage

list_hbsae_models(verbose = FALSE)

Arguments

verbose

Logical. If TRUE, return a data.frame summarising each registered model: family name, default brms link function, whether the family is discrete, and whether brms-canonical mi() imputation is supported. Default FALSE returns a plain character vector of keys (backward compatible).

Value

Character vector of model keys, or a data.frame with columns key, family, link, discrete, supports_mi when verbose = TRUE.

See also

register_hbsae_model, hbm_flex

Examples

list_hbsae_models()
#>  [1] "beta"                        "beta-binomial"              
#>  [3] "binomial"                    "categorical"                
#>  [5] "gaussian"                    "geometric"                  
#>  [7] "loglogistic"                 "lognormal"                  
#>  [9] "multinomial"                 "negbinomial"                
#> [11] "poisson"                     "shifted_loglogistic"        
#> [13] "zero_inflated_beta_binomial" "zero_inflated_binomial"     
#> [15] "zero_inflated_negbinomial"   "zero_inflated_poisson"      
list_hbsae_models(verbose = TRUE)
#>                            key                      family     link discrete
#> 1                         beta                        Beta    logit    FALSE
#> 2                beta-binomial               beta-binomial    logit     TRUE
#> 3                     binomial                    binomial    logit     TRUE
#> 4                  categorical                 categorical    logit     TRUE
#> 5                     gaussian                    gaussian identity    FALSE
#> 6                    geometric                   geometric      log     TRUE
#> 7                  loglogistic           hbsae_loglogistic      log    FALSE
#> 8                    lognormal                   lognormal identity    FALSE
#> 9                  multinomial                 multinomial    logit     TRUE
#> 10                 negbinomial                 negbinomial      log     TRUE
#> 11                     poisson                     poisson      log     TRUE
#> 12         shifted_loglogistic   hbsae_shifted_loglogistic identity    FALSE
#> 13 zero_inflated_beta_binomial zero_inflated_beta_binomial     <NA>     TRUE
#> 14      zero_inflated_binomial      zero_inflated_binomial     <NA>     TRUE
#> 15   zero_inflated_negbinomial   zero_inflated_negbinomial     <NA>     TRUE
#> 16       zero_inflated_poisson       zero_inflated_poisson     <NA>     TRUE
#>    supports_mi
#> 1         TRUE
#> 2        FALSE
#> 3        FALSE
#> 4        FALSE
#> 5         TRUE
#> 6        FALSE
#> 7        FALSE
#> 8         TRUE
#> 9        FALSE
#> 10       FALSE
#> 11       FALSE
#> 12       FALSE
#> 13       FALSE
#> 14       FALSE
#> 15       FALSE
#> 16       FALSE