% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api-simulation.R
\name{summary.mfrm_design_evaluation}
\alias{summary.mfrm_design_evaluation}
\title{Summarize a design-simulation study}
\usage{
\method{summary}{mfrm_design_evaluation}(object, digits = 3, ...)
}
\arguments{
\item{object}{Output from \code{\link[=evaluate_mfrm_design]{evaluate_mfrm_design()}}.}

\item{digits}{Number of digits used in the returned numeric summaries.}

\item{...}{Reserved for generic compatibility.}
}
\value{
An object of class \code{summary.mfrm_design_evaluation} with components:
\itemize{
\item \code{overview}: run-level overview
\item \code{design_summary}: aggregated design-by-facet metrics, with design-variable
alias columns when applicable
\item \code{sparse_review}: compact planned-missingness and rater-link review counts
when sparse linked designs are active
\item \code{ademp}: simulation-study metadata carried forward from the original object
\item \code{facet_names}: public facet labels carried from the simulation specification
\item \code{design_variable_aliases}: accepted public aliases for design variables
\item \code{design_descriptor}: role-based design-variable metadata
\item \code{planning_scope}: explicit record of the current planning contract
\item \code{planning_constraints}: explicit record of mutable/locked design variables
\item \code{planning_schema}: combined planner-schema contract
\item \code{future_branch_active_summary}: compact deterministic summary of the
schema-only future arbitrary-facet planning branch embedded in the current
planning schema
\item \code{notes}: short interpretation notes
}
}
\description{
Summarize a design-simulation study
}
\details{
The summary emphasizes condition-level averages that are useful for practical
design planning, especially:
\itemize{
\item convergence rate
\item separation and reliability by facet
\item severity recovery RMSE
\item mean misfit rate
}
}
\examples{
\donttest{
sim_eval <- suppressWarnings(evaluate_mfrm_design(
  n_person = c(8, 12),
  n_rater = 2,
  n_criterion = 2,
  raters_per_person = 1,
  reps = 1,
  maxit = 30,
  seed = 123
))
s <- summary(sim_eval)
s$overview
head(s$design_summary)
}
}
\seealso{
\code{\link[=evaluate_mfrm_design]{evaluate_mfrm_design()}}, \link{plot.mfrm_design_evaluation}
}
