Summarize a diagnostic-screening validation study
Source:R/api-simulation.R
summary.mfrm_diagnostic_screening.RdSummarizes output from evaluate_mfrm_diagnostic_screening() for reporting,
appendix export, and draw-free visualization handoff. The summary keeps
simulation operating characteristics separate from validation gates: fit,
marginal, pairwise, and report-review signals are screening readouts rather
than pass/fail evidence.
Usage
# S3 method for class 'mfrm_diagnostic_screening'
summary(object, digits = 3, ...)Arguments
- object
Output from
evaluate_mfrm_diagnostic_screening().- digits
Number of digits used in numeric summaries.
- ...
Reserved for generic compatibility.
Value
An object of class summary.mfrm_diagnostic_screening with:
overview: run-level design, replication, convergence, and report-review metadatareading_order: recommended order for reading the summary tablesnext_actions: action-oriented triage for interpreting and exporting the summaryreporting_notes: report-facing boundaries and recommended wording safeguardsfigure_recipes: recommended figure/display recipes for the draw-free plot-data tablesscenario_summary: aggregated scenario-by-design screening summariesperformance_summary: operating-characteristic rates and runtime summariesreport_signal_summary: optionalmfrm_report()readiness/review signalsscenario_contrast: misspecification-minus-well-specified contrastsplot_*: long-form draw-free plot tables for overview, report, contrast, and runtime viewsplanning metadata, settings, ADEMP metadata, and interpretation notes
Examples
if (FALSE) { # \dontrun{
diag_eval <- evaluate_mfrm_diagnostic_screening(
design = list(person = 10, rater = 2, criterion = 2, assignment = 2),
reps = 1,
maxit = 30,
seed = 123
)
summary(diag_eval)
} # }