Build a legacy-compatible output-file bundle (GRAPH= / SCORE=)
Source: R/api-tables.R
facets_output_file_bundle.RdBuild a legacy-compatible output-file bundle (GRAPH= / SCORE=)
Usage
facets_output_file_bundle(
fit,
diagnostics = NULL,
include = c("graph", "score"),
theta_range = c(-6, 6),
theta_points = 241,
digits = 4,
score_se_method = c("both", "native", "score_side", "none"),
include_fixed = FALSE,
fixed_max_rows = 400,
write_files = FALSE,
output_dir = NULL,
file_prefix = "mfrmr_output",
overwrite = FALSE
)Arguments
- fit
Output from
fit_mfrm().- diagnostics
Optional output from
diagnose_mfrm()(used for score file).- include
Output components to include:
"graph"and/or"score".- theta_range
Theta/logit range for graph coordinates.
- theta_points
Number of points on the theta grid for graph coordinates.
- digits
Rounding digits for numeric fields.
- score_se_method
For bounded
GPCMscorefile exports, which observation-level score uncertainty columns to compute."both"(default) includes native structural expected-score SEs and score-side delta-method SEs;"native"includes only the structural expected-score route;"score_side"includes only the score-side delta route;"none"records explicitnot_requestedstatus columns.- include_fixed
If
TRUE, include fixed-width text mirrors of output tables.- fixed_max_rows
Maximum rows shown in fixed-width text blocks.
- write_files
If
TRUE, write selected outputs to files inoutput_dir.- output_dir
Output directory used when
write_files = TRUE.- file_prefix
Prefix used for output file names.
- overwrite
If
FALSE, existing output files are not overwritten.
Value
A named list including:
graphfile/graphfile_syntacticwhen"graph"is requestedscorefilewhen"score"is requestedgraphfile_fixed/scorefile_fixedwheninclude_fixed = TRUEwritten_fileswhenwrite_files = TRUEsettings: applied options
Details
Legacy-compatible output files often include:
graph coordinates for Table 8 curves (
GRAPH=/Graphfile=), andobservation-level modeled score lines (
SCORE=-style inspection).
This helper returns both as data frames and can optionally write CSV/fixed-width text files to disk.
summary(out) is supported through summary().
plot(out) is dispatched through plot() for class
mfrm_output_bundle (type = "graph_expected", "score_residuals",
"obs_probability", "score_se").
Interpreting output
graphfile: legacy-compatible wide curve coordinates (human-readable labels).graphfile_syntactic: same curves with syntactic column names for programmatic use.scorefile: observation-level observed/expected/residual diagnostics.written_files: traceability record of files produced whenwrite_files = TRUE.
For reproducible pipelines, prefer graphfile_syntactic and keep
written_files in run logs.
Preferred route for new analyses
For new scripts, prefer category_curves_report() or
category_structure_report() for scale outputs, then use
export_mfrm_bundle() for file handoff. Use
facets_output_file_bundle() only when a legacy-compatible graphfile or
scorefile contract is required.
Bounded GPCM boundary
For bounded GPCM, graph output and package-native scorefile output are
available with caveats. include = "score" returns observation-level fitted
expected score, residual, standardized residual, observed-category
probability, GPCM slope fields, and native structural delta-method
expected-score uncertainty and/or score-side delta-method SEs when the
required MML diagnostics are available. Use score_se_method to choose
"both" (default), "native", "score_side", or "none".
The scorefile also carries explicit score-side caveat columns. It is not a
FACETS score-side equivalence file, does not export FACETS-equivalent
score-side standard errors, and does not establish an operational
score-scale decision. Use gpcm_score_side_contract() and
gpcm_capability_matrix() for the current scope.
Typical workflow
Fit and diagnose model.
Generate bundle with
include = c("graph", "score").Validate with
summary(out)/plot(out).Export with
write_files = TRUEfor reporting handoff.
Examples
if (FALSE) { # interactive()
toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score", method = "JML", maxit = 30)
out <- facets_output_file_bundle(fit, diagnostics = diagnose_mfrm(fit, residual_pca = "none"))
summary(out)
p_out <- plot(out, draw = FALSE)
p_out$data$plot
}