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

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

\item{...}{Reserved for generic compatibility.}
}
\value{
An object of class \code{summary.mfrm_population_prediction} with:
\itemize{
\item \code{design}: requested future design
\item \code{overview}: run-level overview
\item \code{forecast}: facet-level forecast table
\item \code{facet_names}: public non-person facet names used in the forecast
\item \code{design_variable_aliases}: public aliases for design variables
\item \code{design_descriptor}: role-based description of design variables
\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{gpcm_boundary}: bounded-\code{GPCM} caveat row when present
\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{ademp}: simulation-study metadata
\item \code{notes}: interpretation notes
}
}
\description{
Summarize a population-level design forecast
}
\examples{
\donttest{
spec <- build_mfrm_sim_spec(
  n_person = 16,
  n_rater = 3,
  n_criterion = 2,
  raters_per_person = 2,
  assignment = "rotating"
)
pred <- predict_mfrm_population(
  sim_spec = spec,
  design = list(person = 18),
  reps = 1,
  maxit = 30,
  seed = 123
)
s <- summary(pred)
s$overview
s$forecast[, c("Facet", "MeanSeparation", "McseSeparation")]
}
}
\seealso{
\code{\link[=predict_mfrm_population]{predict_mfrm_population()}}
}
