Skip to contents

Extract the shrinkage report from a fitted mfrm_fit

Source: R/api-shrinkage.R
shrinkage_report.Rd

Lightweight accessor that returns the per-facet empirical-Bayes shrinkage table stored on a fit when facet_shrinkage != "none". Returns NULL (with a message) when no shrinkage has been applied so callers can probe without error.

Usage

shrinkage_report(fit)

Arguments

fit

An mfrm_fit object.

Value

A data.frame with one row per facet (and optionally "Person") or NULL when shrinkage has not been applied.

See also

apply_empirical_bayes_shrinkage(), fit_mfrm().

Examples

# Supplementary workflow: run explicitly to keep routine checks brief.
# example("shrinkage_report", run.dontrun = TRUE)
if (FALSE) { # \dontrun{
toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score",
                method = "JML", maxit = 300,
                facet_shrinkage = "empirical_bayes")
shrinkage_report(fit)
} # }