Random-effect compilation policy

random_effects_compile() specifies which resolved formula random-effect blocks are compiled as structural marginalized blocks. Blocks not listed in marginalized are compiled as ordinary sampled random effects. Marginalized blocks keep their SD, allocation, correlation, covariance-structure, and metadata, but do not generate latent group-level coefficients and do not contribute to the formula linear predictor. Callers that marginalize a block are responsible for using the stored metadata and generated hyperparameter nodes in their likelihood.

random_effects_compile(marginalized = NULL)

Arguments

marginalized

optional character vector of resolved random-effect block names that should be compiled structurally without latent group-level coefficients.

Value

A list-like S3 object containing the requested marginalized block names, used by JAGS_formula(), JAGS_fit(), and JAGS_bridgesampling(). Resolved formula-design metadata additionally records the complete sampled, marginalized, and named mode outputs.

Examples

random_effects_compile()
#> $marginalized
#> NULL
#> 
#> attr(,"class")
#> [1] "random_effects_compile" "list"                  
random_effects_compile(marginalized = "study_estimate")
#> $marginalized
#> [1] "study_estimate"
#> 
#> attr(,"class")
#> [1] "random_effects_compile" "list"