mfrmr_output_guide: Choose an mfrmr output helper by user goal

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

Choose an mfrmr output helper by user goal

Description

mfrmr_output_guide() returns a compact table for choosing among the main table, report, review, bundle, export, and compatibility helpers. It is a user-facing map, not an analysis result.

Usage

mfrmr_output_guide(
  scope = c("all", "public", "entry", "viewer", "binary", "tables", "reports", "reviews",
    "bundles", "exports", "compatibility", "gpcm", "simulation", "linking", "network",
    "response_time", "facets", "conquest", "r")
)

Arguments

scope

Which rows to return. "all" returns the full guide. "public" returns the small top-level public surface for most users. "entry" returns the recommended first-screen routes. "viewer" returns local-viewer routes built around mfrm_results(include = ...). "binary" returns the two-category person-item Rasch route and checks. Other values filter to one output family or to bounded-GPCM-relevant routes. "linking" returns anchor, drift, and equating route rows. "simulation" and "network" return advanced design-review rows. "response_time" returns descriptive response-time QC rows. "facets", "conquest", and "r" return user-pathway rows for people arriving from those workflows.

Details

Naming convention used by the guide:

• ⁠*_table⁠: focused table or table-like result for one evidence source

• ⁠*_report⁠: multi-table evidence bundle for a reporting question

• ⁠*_review⁠: status, interpretation, or decision-support object

• ⁠*_bundle⁠: reusable collection of tables/metadata for handoff

• ⁠export_*⁠: writes files or appendix artifacts

Value

A data.frame with one row per recommended route and columns:

• Scope

• Question

• OutputFamily

• Lifecycle

• UserLevel

• APILayer

• ObjectRole

• DecisionBoundary

• RecommendedEntry

• MainFunction

• UseWhen

• TypicalInput

• NextStep

• GPCMStatus

• Notes

First-screen route

Use mfrmr_output_guide("public") when you want the shortest top-level API map. Use mfrmr_output_guide("entry") when you specifically want first-screen creation routes. The entry guide points new scripts to fit_mfrm() -> diagnose_mfrm() -> mfrm_results(), existing fits to mfrm_results(), and exploratory console work to mfrm_results_interactive(). After creating res, use summary(res)$next_actions to choose the next purpose-specific helper. Use mfrmr_output_guide("viewer") when the next step is the optional local Shiny reader; it shows which include preset to use before calling launch_mfrmr_viewer().

How to use this guide

Treat MainFunction as the route to try next and UseWhen as the guardrail. The guide is not a replacement for the help pages of the listed functions; it is a namespace map for deciding which page to open. For bounded GPCM, use scope = "gpcm" to find both the support matrix and the table that explains how out-of-scope routes are handled.

Examples

public <- mfrmr_output_guide("public")
public[, c("Question", "APILayer", "ObjectRole", "MainFunction")]

entry <- mfrmr_output_guide("entry")
entry[, c("Question", "Lifecycle", "UserLevel", "MainFunction")]

reviews <- mfrmr_output_guide("reviews")
reviews[, c("Question", "MainFunction", "UseWhen")]

mfrmr_output_guide("gpcm")[, c("Question", "MainFunction", "GPCMStatus")]
mfrmr_output_guide("simulation")[, c("Question", "Lifecycle")]
mfrmr_output_guide("linking")[, c("Question", "MainFunction")]
mfrmr_output_guide("facets")[, c("Question", "MainFunction")]
mfrmr_output_guide("binary")[, c("Question", "MainFunction")]
mfrmr_output_guide("viewer")[, c("Question", "MainFunction")]
mfrmr_output_guide("response_time")[, c("Question", "MainFunction")]

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