Summarize APA report-output bundles
Usage
# S3 method for class 'mfrm_apa_outputs'
summary(object, top_n = 3, preview_chars = 160, ...)Arguments
- object
Output from
build_apa_outputs().- top_n
Maximum non-empty lines shown in each component preview.
- preview_chars
Maximum characters shown in each preview cell.
- ...
Reserved for generic compatibility.
Details
This summary is a diagnostics layer for APA text products, not a replacement for the full narrative.
It reports component completeness, line/character volume, and a compact preview for quick QA before manuscript insertion.
Interpreting output
overview: total coverage across standard text components.components: per-component density and mention checks (including residual-PCA mentions).sections: package-native section coverage table.content_checks: contract-based alignment checks for APA drafting readiness.overview$DraftContractPass: the primary contract-completeness flag for draft text components.overview$ReadyForAPA: a backward-compatible alias of that contract flag, not a certification of inferential adequacy.preview: first non-empty lines for fast visual review.
Typical workflow
Build outputs via
build_apa_outputs().Run
summary(apa)to screen for empty/short components.Use
apa$report_text,apa$table_figure_notes, andapa$table_figure_captionsas draft components for final-text review.
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")
apa <- build_apa_outputs(fit, diag)
summary(apa)
#> mfrmr APA Outputs Summary
#>
#> Overview
#> Components NonEmptyComponents TotalCharacters TotalNonEmptyLines Sections
#> 3 3 6058 88 8
#> AvailableSections ContentChecks ContentChecksPassed DraftContractPass
#> 7 9 8 FALSE
#> ReadyForAPA
#> FALSE
#>
#> Component stats
#> Component NonEmpty Characters Lines NonEmptyLines
#> report_text TRUE 2420 45 37
#> table_figure_notes TRUE 3108 44 30
#> table_figure_captions TRUE 530 35 21
#> ResidualPCA_Mentions
#> 2
#> 2
#> 2
#>
#> Sections
#> SectionId Parent Heading Available SentenceCount
#> method_design Method Design and data TRUE 2
#> method_estimation Method Estimation settings TRUE 5
#> results_scale Results Scale functioning TRUE 2
#> results_measures Results Facet measures TRUE 3
#> results_fit_precision Results Fit and precision TRUE 5
#> results_residual_structure Results Residual structure TRUE 3
#> results_bias_screening Results Bias screening FALSE 0
#> results_cautions Results Reporting cautions TRUE 1
#> Text
#> A many-facet Rasch model (MFRM) was fit to 768 observations from 48 persons scored on a\n4-category scale (1-4). The design included facets for Rater (n = 4), Criterion (n = 4).
#> The RSM specification was estimated using JMLE in the native R MFRM package. Precision\nsummaries were exploratory in this run. Recommended use for this precision profile: Use for\nscreening and calibration triage; confirm formal SE, CI, and reliability with an MML fit..\nOptimization converged after 67 function evaluations (LogLik = -820.949, AIC = 1755.899,\nBIC = 2020.595). Constraint settings: noncenter facet = Person; anchored levels = 0\n(facets: none); group anchors = 0 (facets: none); dummy facets = none.
#> Category usage was adequate (unused categories = 0, low-count categories = 0), and\nthresholds were ordered. Step/threshold summary: 3 step(s); estimate range = -1.33 to 1.39\nlogits; no disordered steps.
#> Person measures ranged from -2.18 to 2.69 logits (M = 0.00, SD = 1.10). Rater measures\nranged from -0.33 to 0.33 logits (M = 0.00, SD = 0.31). Criterion measures ranged from\n-0.41 to 0.25 logits (M = 0.00, SD = 0.29).
#> Overall fit was acceptable (infit MnSq = 0.99, outfit MnSq = 1.02). 1 of 56 elements\nexceeded the 0.5-1.5 fit range. Largest misfit signals: Person:P023 (|metric| = 3.06);\nPerson:P018 (|metric| = 1.51); Criterion:Organization (|metric| = 1.42). Criterion\nexploratory reliability summary = 0.88 (separation = 2.77). Person exploratory reliability\nsummary = 0.90 (separation = 3.01). Rater exploratory reliability summary = 0.90\n(separation = 3.05). For Rater, exact agreement = 0.36, expected exact agreement = 0.37,\nadjacent agreement = 0.83.
#> Exploratory residual PCA (overall standardized residual matrix) showed PC1 eigenvalue =\n2.11 (13.2% variance), with PC2 eigenvalue = 1.83. Facet-specific exploratory residual PCA\nshowed the largest first-component signal in Rater (eigenvalue = 1.72, 43.0% variance).\nHeuristic reference bands: EV >= 1.4 (critical minimum), >= 1.5 (caution), >= 2.0 (common),\n>= 3.0 (strong); variance >= 5% (minor), >= 10% (caution), >= 20% (strong).
#>
#> Precision note: this run relies on exploratory precision summaries, so confidence intervals\nand reliability summaries should not be treated as formal inferential quantities.
#>
#> Content checks
#> Check Passed
#> Method section heading TRUE
#> Results section heading TRUE
#> Precision caution alignment TRUE
#> Bias screening note alignment TRUE
#> Residual PCA coverage FALSE
#> Note coverage TRUE
#> Caption coverage TRUE
#> Core section coverage TRUE
#> Interrater summary alignment TRUE
#> Detail
#> APA narrative should begin with a Method heading.
#> APA narrative should include a Results heading.
#> Precision caution should appear in the report text or note blocks.
#> No bias screening block required.
#> Residual PCA availability should be reflected in prose, notes, and captions.
#> All note-map entries should be represented in the consolidated note text.
#> All caption-map entries should be represented in the consolidated caption text.
#> Core package-native sections should be available in the section map.
#> Interrater agreement wording should appear in the report text or notes.
#>
#> Preview
#> Component
#> report_text
#> table_figure_notes
#> table_figure_captions
#> Preview
#> Method. | Design and data. | A many-facet Rasch model (MFRM) was fit to 768 observations from 48 persons scored on a
#> Table 1. Facet summary | Note. Measures are reported in logits; higher values indicate more of the modeled trait for that facet. Model S.E. = exploratory sta...
#> Table 1 | Facet Summary (Measures, Precision, Fit, Reliability) | Table 2
#>
#> Notes
#> - All standard APA text components are populated.Content checks needing review: Residual PCA coverage.In this summary, ReadyForAPA/DraftContractPass indicates contract completeness for draft text components; it does not certify formal inferential adequacy.Use object fields directly for full text; summary provides compact diagnostics.