write_mfrm_residual_file: Write a standalone residual file

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

Write a standalone residual file

Description

Write a standalone residual file

Usage

write_mfrm_residual_file(
  fit,
  diagnostics = NULL,
  path,
  format = c("csv", "tsv"),
  digits = 4,
  overwrite = FALSE,
  include_probabilities = FALSE
)

Arguments

fit	Output from fit_mfrm().
diagnostics	Optional output from diagnose_mfrm(). Supplying it avoids recomputing observation diagnostics.
path	Output file path.
format	File format: "csv" or "tsv". If omitted, inferred from path when the extension is .csv or .tsv, otherwise "csv".
digits	Rounding digits for numeric columns.
overwrite	If FALSE, existing files are not overwritten.
include_probabilities	If TRUE, append model probabilities for all response categories as ⁠PrCategory_*⁠ columns.

Details

The exported table is observation-level and model-native. It includes the observed score, expected score, residual, standardized residual, variance, score information, observed-category probability, and modeled person measure when those quantities are available.

This writer is separate from facets_output_file_bundle() because it is a direct analysis handoff rather than a legacy graph/score bundle.

Value

A bundle with table, summary, written_files, and settings.

See Also

diagnose_mfrm(), facets_output_file_bundle(), write_mfrm_subset_file()

Examples

toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score",
                method = "JML", maxit = 30)
diag <- diagnose_mfrm(fit, residual_pca = "none")
path <- tempfile(fileext = ".csv")
out <- write_mfrm_residual_file(fit, diag, path, overwrite = TRUE)
out$written_files

mfrmr documentation built on June 13, 2026, 1:07 a.m.