mfrmr_interval_guide: Confidence-interval and uncertainty route guide

View source: R/help_visual_diagnostics.R

mfrmr_interval_guideR Documentation

Confidence-interval and uncertainty route guide

Description

Return a compact map of the public mfrmr routes that can expose confidence intervals or interval-like uncertainty displays. Use this when you need to know which helper accepts show_ci or ci_level, which columns to look for in draw = FALSE output, and how strongly the resulting interval should be interpreted.

Usage

mfrmr_interval_guide(
  scope = c("all", "visual", "table", "reporting", "fit", "bias", "linking", "gpcm",
    "equivalence", "hierarchical", "shrinkage")
)

Arguments

scope

Which rows to return: "all" (default), "visual", "table", "reporting", "fit", "bias", "linking", "gpcm", "equivalence", "hierarchical", or "shrinkage".

Details

The guide is deliberately conservative. It is a namespace and interpretation map, not a fitted result and not proof that a given interval is available for a particular run. For run-specific availability, call the listed helper with draw = FALSE or inspect the relevant result table.

Most rows use ci_level = 0.95 by default. Some intervals are model-based Wald intervals, some are delta-method intervals, some are profile or profile-like intervals when available, and some are plotting overlays around already-estimated quantities. The Basis and InterpretationBoundary columns are the important guardrails.

Value

A data.frame with columns:

  • Route

  • Scope

  • PrimaryHelper

  • DisplayRoute

  • DefaultLevel

  • IntervalColumns

  • Basis

  • UseFor

  • InterpretationBoundary

  • GPCMStatus

  • Notes

See Also

mfrmr_visual_diagnostics, visual_reporting_template(), plot_fair_average(), plot_bias_interaction(), plot_displacement(), plot_wright_unified(), plot_rater_severity_profile(), plot_apa_figure_one(), fit_measures_table()

Examples

mfrmr_interval_guide()
mfrmr_interval_guide("visual")[, c("Route", "DisplayRoute", "Basis")]
mfrmr_interval_guide("gpcm")[, c("Route", "GPCMStatus", "InterpretationBoundary")]

mfrmr documentation built on June 13, 2026, 1:07 a.m.