Build a specification summary report (preferred alias)

Build a specification summary report (preferred alias)

Usage

specifications_report(
  fit,
  title = NULL,
  data_file = NULL,
  output_file = NULL,
  include_fixed = FALSE
)

Arguments

fit

Output from fit_mfrm().

title

Optional analysis title.

data_file

Optional data-file label (for reporting only).

output_file

Optional output-file label (for reporting only).

include_fixed

If TRUE, include a legacy-compatible fixed-width text block.

Value

A named list with specification-report components. Class: mfrm_specifications.

Details

summary(out) is supported through summary(). plot(out) is dispatched through plot() for class mfrm_specifications (type = "facet_elements", "anchor_constraints", "convergence").

Interpreting output

• header / data_spec: run identity and model settings. CenteringScope is "facet" for whole-facet centering or "remainder" for the legacy constraint on ungrouped, unanchored levels. It applies only to centered facets; NonCenteredFacet remains separate. Older native fits without convention metadata retain "remainder"; an input without a stored constraint specification is "not_recorded".

• facet_labels: facet sizes and labels.

• convergence_control: optimizer configuration and status.

Typical workflow

1. Generate specifications_report(fit).

2. Verify model settings and convergence metadata.

3. Use the output as methods and run-documentation support in reports.

See also

fit_mfrm(), data_quality_report(), estimation_iteration_report(), mfrmr_reports_and_tables, mfrmr_compatibility_layer

Examples

# Supplementary workflow: run explicitly to keep routine checks brief.
# example("specifications_report", run.dontrun = TRUE)
if (FALSE) { # \dontrun{
toy <- load_mfrmr_data("example_operational")
fit <- fit_mfrm(
  toy, "Person", c("Rater", "Criterion"), "Score",
  method = "MML", quad_points = 7, maxit = 30
)
out <- specifications_report(fit, title = "Toy run")
summary(out)
p_spec <- plot(out, draw = FALSE)
p_spec$data$plot
} # }