% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api-reports.R
\name{summary.mfrm_apa_outputs}
\alias{summary.mfrm_apa_outputs}
\title{Summarize APA report-output bundles}
\usage{
\method{summary}{mfrm_apa_outputs}(object, top_n = 3, preview_chars = 160, ...)
}
\arguments{
\item{object}{Output from \code{\link[=build_apa_outputs]{build_apa_outputs()}}.}

\item{top_n}{Maximum non-empty lines shown in each component preview.}

\item{preview_chars}{Maximum characters shown in each preview cell.}

\item{...}{Reserved for generic compatibility.}
}
\value{
An object of class \code{summary.mfrm_apa_outputs}.
}
\description{
Summarize APA report-output bundles
}
\details{
This summary is a diagnostics layer for APA text products, not a replacement
for the full narrative.

It reports component completeness, line/character volume, and a compact
preview for quick QA before manuscript insertion.
}
\section{Interpreting output}{

\itemize{
\item \code{overview}: total coverage across standard text components.
\item \code{components}: per-component density and mention checks
(including residual-PCA mentions).
\item \code{sections}: package-native section coverage table.
\item \code{content_checks}: contract-based alignment checks for APA drafting readiness.
\item \code{overview$DraftContractPass}: the primary contract-completeness flag for
draft text components.
\item \code{overview$ReadyForAPA}: a backward-compatible alias of that contract flag,
not a certification of inferential adequacy.
\item \code{preview}: first non-empty lines for fast visual review.
}
}

\section{Typical workflow}{

\enumerate{
\item Build outputs via \code{\link[=build_apa_outputs]{build_apa_outputs()}}.
\item Run \code{summary(apa)} to screen for empty/short components.
\item Use \code{apa$report_text}, \code{apa$table_figure_notes},
and \code{apa$table_figure_captions} as draft components for final-text review.
}
}

\examples{
toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score", method = "JML", maxit = 30)
diag <- diagnose_mfrm(fit, residual_pca = "none")
apa <- build_apa_outputs(fit, diag)
summary(apa)
}
\seealso{
\code{\link[=build_apa_outputs]{build_apa_outputs()}}, \code{\link[=summary]{summary()}}
}
