reporting_checklist: Build an auto-filled MFRM reporting checklist

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

Build an auto-filled MFRM reporting checklist

Description

Build an auto-filled MFRM reporting checklist

Usage

reporting_checklist(
  fit,
  diagnostics = NULL,
  bias_results = NULL,
  include_references = TRUE
)

Arguments

fit	Output from fit_mfrm().
diagnostics	Optional output from diagnose_mfrm(). When NULL, diagnostics are computed with residual_pca = "none".
bias_results	Optional output from estimate_bias() or a named list of such outputs.
include_references	If TRUE, include a compact reference table in the returned bundle.

Details

This helper ports the app-level reporting checklist into a package-native bundle. It does not try to judge substantive reporting quality; instead, it checks whether the fitted object and related diagnostics contain the evidence typically reported in MFRM write-ups.

Checklist items are grouped into seven sections:

• Method section

• Global fit

• Facet-level statistics

• Element-level statistics

• Rating scale diagnostics

• Bias/interaction analysis

• Visual displays

The output is designed for manuscript preparation, audit trails, and reproducible reporting workflows.

Value

A named list with checklist tables. Class: mfrm_reporting_checklist.

What this checklist means

reporting_checklist() is a content-availability contract. It tells you which reporting elements are already present in the current analysis objects and which still need to be generated or documented. The primary draft-status column is DraftReady; ReadyForAPA is retained as a backward-compatible alias.

What this checklist does not justify

• It is not a single run-level pass/fail decision for publication.

• DraftReady = TRUE / ReadyForAPA = TRUE does not certify formal inferential adequacy.

• Missing bias rows may simply mean bias_results were not supplied.

Interpreting output

• checklist: one row per reporting item with Available = TRUE/FALSE. DraftReady = TRUE means the item can be drafted into a report with the package's documented caveats. ReadyForAPA is a backward-compatible alias of the same flag; neither field certifies formal inferential adequacy.

• section_summary: available items by section.

• references: core background references when requested.

Recommended next step

Review the rows with Available = FALSE or DraftReady = FALSE, then add the missing diagnostics, bias results, or narrative context before calling build_apa_outputs() for draft text generation.

Typical workflow

1. Fit with fit_mfrm().

2. Compute diagnostics with diagnose_mfrm().

3. Run reporting_checklist() to see which reporting elements are already available from the current analysis objects.

See Also

build_apa_outputs(), build_visual_summaries(), specifications_report(), data_quality_report()

Examples

toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score",
                method = "JML", maxit = 25)
diag <- diagnose_mfrm(fit, residual_pca = "both")
chk <- reporting_checklist(fit, diagnostics = diag)
summary(chk)
apa <- build_apa_outputs(fit, diag)
head(chk$checklist[, c("Section", "Item", "DraftReady", "NextAction")])
nchar(apa$report_text)

mfrmr documentation built on March 31, 2026, 1:06 a.m.