Writes tidy CSV files suitable for import into spreadsheet software or further analysis in other tools.
Usage
export_mfrm(
fit,
diagnostics = NULL,
output_dir = ".",
prefix = "mfrm",
tables = c("person", "facets", "summary", "steps", "measures"),
overwrite = FALSE,
acknowledge_sensitive = FALSE
)Arguments
- fit
Output from
fit_mfrm.- diagnostics
Optional output from
diagnose_mfrm. When provided, enriches facet estimates with SE, fit statistics, and writes the full measures table.- output_dir
Directory for CSV files. Created if it does not exist.
- prefix
Filename prefix (default
"mfrm").- tables
Character vector of tables to export. Any subset of
"person","facets","summary","steps","measures". Default exports all available tables.- overwrite
If
FALSE(default), refuse to overwrite existing files.- acknowledge_sensitive
Logical; set to
TRUEonly after acknowledging that these tables can contain direct person identifiers, person-level estimates, and original facet labels. This suppresses the privacy warning; it does not deidentify any file.
Value
Invisibly, a data.frame listing written files, their paths, and
explicit privacy/data-handling metadata. Deidentified and
ShareableWithoutReview are always FALSE.
Exported files
{prefix}_person_estimates.csvPerson ID, Estimate, SD.
{prefix}_facet_estimates.csvFacet, Level, Estimate, and optionally SE, Infit, Outfit, PTMEA when diagnostics supplied.
{prefix}_fit_summary.csvOne-row model summary.
{prefix}_step_parameters.csvStep/threshold parameters.
{prefix}_measures.csvFull measures table (requires diagnostics).
Interpreting output
The returned data.frame tells you exactly which files were written and where. This is convenient for scripted pipelines where the output directory is created on the fly. The files are analysis tables, not a deidentified sharing package; review each file under the applicable data-handling policy before sharing it.
Typical workflow
Fit a model with
fit_mfrm().Optionally compute diagnostics with
diagnose_mfrm()when you want enriched facet or measures exports.Call
export_mfrm(...)and inspect the returnedPathcolumn.
Examples
# \donttest{
toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score",
method = "JML", model = "RSM", maxit = 30)
#> Warning: Optimization convergence review did not produce an inference-ready numerical solution (code = 1, status = iteration_limit). Optimizer reached the iteration limit before the terminal gradient became small enough for review-only acceptance. Inspect the model specification, data support, and starting values. Do not interpret estimates until the review is resolved.
diag <- diagnose_mfrm(fit, residual_pca = "none")
out <- export_mfrm(
fit,
diagnostics = diag,
output_dir = tempdir(),
prefix = "mfrmr_example",
overwrite = TRUE,
acknowledge_sensitive = TRUE
)
out$Table
#> [1] "person" "facets" "summary" "steps" "measures"
# }
