launch_mfrmr_viewer: Launch a local Shiny viewer for an mfrm_results object

In mfrmr: Estimation and Diagnostics for Many-Facet Measurement Models

Launch a local Shiny viewer for an mfrm_results object

Description

launch_mfrmr_viewer() opens a local Shiny app for reading the object returned by mfrm_results(). It is intentionally a viewer over an existing comprehensive results object, not a new estimation interface.

Usage

launch_mfrmr_viewer(
  x,
  top_n = 100L,
  launch.browser = TRUE,
  port = NULL,
  host = getOption("shiny.host", "127.0.0.1"),
  display.mode = c("auto", "normal", "showcase"),
  return_app = FALSE,
  ...
)

Arguments

x	An mfrm_results() object.
top_n	Maximum number of table-index rows shown in the summary payload.
launch.browser	Passed to shiny::runApp().
port	Optional port passed to shiny::runApp(). NULL lets Shiny choose its default.
host	Host passed to shiny::runApp(). Defaults to the local host.
display.mode	Passed to shiny::runApp().
return_app	Logical; if TRUE, return the Shiny app object without running it. This is useful for embedding or testing.
...	Additional arguments passed to shiny::runApp() when return_app = FALSE.

Details

The viewer assumes that fitting, diagnostics, and section selection have already happened through mfrm_results(). This keeps GUI exploration separate from reproducible analysis setup: the Replay tab displays the mfrm_results() scaffold stored in the result object.

The app includes tabs for overview/triage, QC evidence, APA-style report text when include = "publication" or "apa" was used, available bias screens, pathway plotting, unexpected-response inspection, generic tables, generic plot routes, and replay code. QC, Report, Bias, and Pathway/Misfit tabs show local section-status tables so unavailable or not-requested sections are visible where users look for them. Bias-interaction follow-up still requires an explicit facet-pair decision outside the viewer.

shiny is an optional dependency. Install it before using this viewer: install.packages("shiny").

Value

Invisibly returns the value from shiny::runApp(), or the Shiny app object when return_app = TRUE.

See Also

mfrm_results(), mfrm_results_interactive()

Examples

toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(
  toy,
  person = "Person",
  facets = c("Rater", "Criterion"),
  score = "Score",
  method = "JML",
  maxit = 30
)
res <- mfrm_results(fit, include = c("fit", "diagnostics", "tables"))

if (interactive() && requireNamespace("shiny", quietly = TRUE)) {
  launch_mfrmr_viewer(res)
}

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