Inspect a Registered HBSAE Model Specification

Inspect a Registered HBSAE Model Specification

Usage

get_hbsae_model(key)

Arguments

key

Character. A model key returned by list_hbsae_models.

Value

The named list spec, or NULL if not found. Useful fields include:

• family – brms family name passed to brmsfamily.

• link – default link function used by the family ("identity", "logit", "log", ...). See brmsfamily for the complete set of supported links per family.

• discrete – whether the response is discrete.

• supports_mi – whether brms-canonical mi() imputation is allowed for this family (FALSE for all discrete responses).

See also

register_hbsae_model, brmsfamily for the canonical brms family / link reference.

Examples

get_hbsae_model("lognormal")
#> $family
#> [1] "lognormal"
#> 
#> $link
#> [1] "identity"
#> 
#> $discrete
#> [1] FALSE
#> 
#> $supports_mi
#> [1] TRUE
#> 
#> $has_addition_term
#> [1] FALSE
#> 
#> $addition_template
#> NULL
#> 
#> $response_check
#> function(y) {
#>         v <- y[!is.na(y)]
#>         length(v) == 0L || all(v > 0)
#>       }
#> <bytecode: 0x5630726f9120>
#> <environment: 0x56307270efd0>
#> 
#> $response_check_msg
#> [1] "Lognormal response must be strictly positive (y > 0)."
#> 
#> $default_priors
#> function(...) NULL
#> <bytecode: 0x5630726ffe40>
#> <environment: 0x56307270efd0>
#> 
get_hbsae_model("beta")$link  # "logit"
#> [1] "logit"