% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api-reports.R
\name{specifications_report}
\alias{specifications_report}
\title{Build a specification summary report (preferred alias)}
\usage{
specifications_report(
  fit,
  title = NULL,
  data_file = NULL,
  output_file = NULL,
  include_fixed = FALSE
)
}
\arguments{
\item{fit}{Output from \code{\link[=fit_mfrm]{fit_mfrm()}}.}

\item{title}{Optional analysis title.}

\item{data_file}{Optional data-file label (for reporting only).}

\item{output_file}{Optional output-file label (for reporting only).}

\item{include_fixed}{If \code{TRUE}, include a legacy-compatible fixed-width text
block.}
}
\value{
A named list with specification-report components. Class:
\code{mfrm_specifications}.
}
\description{
Build a specification summary report (preferred alias)
}
\details{
\code{summary(out)} is supported through \code{summary()}.
\code{plot(out)} is dispatched through \code{plot()} for class
\code{mfrm_specifications} (\code{type = "facet_elements"},
\code{"anchor_constraints"}, \code{"convergence"}).
}
\section{Interpreting output}{

\itemize{
\item \code{header} / \code{data_spec}: run identity and model settings.
\item \code{facet_labels}: facet sizes and labels.
\item \code{convergence_control}: optimizer configuration and status.
}
}

\section{Typical workflow}{

\enumerate{
\item Generate \code{specifications_report(fit)}.
\item Verify model settings and convergence metadata.
\item Use the output as methods and run-documentation support in reports.
}
}

\examples{
toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score", method = "JML", maxit = 30)
out <- specifications_report(fit, title = "Toy run")
summary(out)
p_spec <- plot(out, draw = FALSE)
p_spec$data$plot
}
\seealso{
\code{\link[=fit_mfrm]{fit_mfrm()}}, \code{\link[=data_quality_report]{data_quality_report()}}, \code{\link[=estimation_iteration_report]{estimation_iteration_report()}},
\link{mfrmr_reports_and_tables}, \link{mfrmr_compatibility_layer}
}
