Summarize a reporting-checklist bundle for manuscript work
Source:R/api-reporting-checklist.R
summary.mfrm_reporting_checklist.RdSummarize a reporting-checklist bundle for manuscript work
Usage
# S3 method for class 'mfrm_reporting_checklist'
summary(object, top_n = 10, ...)Arguments
- object
Output from
reporting_checklist().- top_n
Maximum number of draft-action rows shown in the compact action table.
- ...
Reserved for generic compatibility.
Value
An object of class summary.mfrm_reporting_checklist with:
overview: run-level counts of available and draft-ready itemssection_summary: section-level checklist coveragesoftware_scope: external-software relationship summaryfacets_positioning: report-ready FACETS relationship wordingvisual_scope: plotting-route and 3D-ready data-handoff summary, including the mainInterpretationCheckcaveat for each visual familypriority_summary: counts by priority/severityaction_items: highest-priority rows that still need draft worksettings: checklist settings rendered as a compact tablenotes: interpretation notes
Examples
if (FALSE) { # \dontrun{
toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score",
method = "MML", quad_points = 7, maxit = 30)
diag <- diagnose_mfrm(fit, residual_pca = "both", diagnostic_mode = "both")
chk <- reporting_checklist(fit, diagnostics = diag)
summary(chk)
} # }