Write an editable or print-ready analysis report

Renders the active Rasch or paired-comparison fit as a self-contained HTML document, an editable Word document, or a PDF. The report contains the principal estimates, model-specific tables, diagnostic figures, and software provenance. Complete machine-readable results remain available from save_outputs. Reports downloaded from the application retain compatible tailored item shifts and externally weighted secondary person measures. For keyed fits with repeated person IDs, the report explains why distractor analysis is unavailable and retains the other model outputs.

Usage

report_document(
  fit,
  file,
  format = c("auto", "html", "docx", "pdf"),
  title = "Rasch measurement analysis",
  dif = NULL,
  bootstrap = NULL,
  dif_bootstrap = NULL,
  dimensionality = NULL,
  invariance = NULL,
  subtest = NULL,
  tailored = NULL,
  person_weights = NULL
)

Arguments

fit: A fitted object from rasch, rasch_mfrm, rasch_efrm, btl, or btl_efrm.
file: Output path ending in .html, .docx, or .pdf.
format: Output format. By default it is inferred from file.
title: Report title.
dif, bootstrap: Optional computed dif_anova and fit_bootstrap results from this fit, rendered as run rather than recomputed at defaults.
dif_bootstrap: Optional dif_bootstrap sensitivity analysis from this fit and DIF specification.
dimensionality: Optional computed plot_scree or btl_dimensionality result from this fit.
invariance: Optional computed frame_invariance result from an EFRM fit.
subtest: Optional computed dimensionality_test result from this fit.
tailored: Optional computed tailored_analysis result from this ordinary dichotomous fit.
person_weights: Optional table returned by weighted_person_estimates. An explicit table takes precedence over a compatible result retained by the application.

Value

Invisibly, the output path.

Details

Word and HTML output require Pandoc, supplied with RStudio and available through rmarkdown. PDF output also requires a LaTeX installation such as TinyTeX.

Examples

if (FALSE) { # \dontrun{
fit <- rasch(matrix(rbinom(3000, 1, .5), 300, 10))
report_document(fit, file.path(tempdir(), "analysis.docx"))
} # }