% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api-reports.R
\name{estimation_iteration_report}
\alias{estimation_iteration_report}
\title{Build an estimation-iteration report (preferred alias)}
\usage{
estimation_iteration_report(
  fit,
  max_iter = 20,
  reltol = NULL,
  include_prox = TRUE,
  include_fixed = FALSE
)
}
\arguments{
\item{fit}{Output from \code{\link[=fit_mfrm]{fit_mfrm()}}.}

\item{max_iter}{Maximum replay iterations (excluding optional initial row).}

\item{reltol}{Stopping tolerance for replayed max-logit change.}

\item{include_prox}{If \code{TRUE}, include an initial pseudo-row labeled \code{PROX}.}

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

\itemize{
\item \code{iterations}: trajectory of convergence indicators by iteration.
\item \code{summary}: final status and stopping diagnostics.
\item optional \code{PROX} row: pseudo-initial reference point when enabled.
}
}

\section{Typical workflow}{

\enumerate{
\item Run \code{estimation_iteration_report(fit)}.
\item Inspect plateau/stability patterns in summary/plot.
\item Adjust optimization settings if convergence looks weak.
}
}

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