% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api-reports.R
\name{summary.mfrm_summary_table_bundle}
\alias{summary.mfrm_summary_table_bundle}
\title{Summarize a summary-table bundle for manuscript QC}
\usage{
\method{summary}{mfrm_summary_table_bundle}(object, digits = 3, top_n = 8, ...)
}
\arguments{
\item{object}{Output from \code{\link[=build_summary_table_bundle]{build_summary_table_bundle()}}.}

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

\item{top_n}{Maximum number of table-profile rows to keep.}

\item{...}{Reserved for generic compatibility.}
}
\value{
An object of class \code{summary.mfrm_summary_table_bundle}.
}
\description{
Summarize a summary-table bundle for manuscript QC
}
\details{
This summary is designed to answer a manuscript-facing question: which
reporting tables are available, how large are they, which roles do they
serve, and which of them contain numeric content suitable for quick plotting
or appendix export.
}
\section{Interpreting output}{

\itemize{
\item \code{overview}: source class, returned-table count, note count, and whether a
numeric table is available for plotting.
\item \code{role_summary}: counts and total size by reporting role.
\item \code{table_catalog}: complete returned-table registry with plot/export bridges.
\item \code{table_profile}: table-level dimensions, numeric-column counts, and missing
values for the largest returned tables.
\item \code{plot_index}: which returned tables are plot-ready and which bundle-level
numeric QC routes they support.
\item \code{appendix_presets}: conservative \code{all} / \code{recommended} / \code{compact}
plus section-aware \code{methods} / \code{results} / \code{diagnostics} / \code{reporting}
appendix-export presets derived from table roles.
\item \code{appendix_role_summary}: counts of returned tables by reporting role under
the same conservative appendix routing used by the bundle catalog.
\item \code{appendix_section_summary}: counts of returned tables by manuscript-facing
appendix section.
\item \code{selection_handoff_table_summary}: workflow-only table-level appendix
handoff crosswalk when present in the bundle.
\item \code{selection_handoff_preset_summary}: workflow-only appendix handoff overview
aggregated at the preset level when present in the bundle.
\item \code{selection_handoff_bundle_summary}: workflow-only appendix handoff
overview aggregated at the bundle-by-section level when present in the
bundle.
\item \code{selection_handoff_role_summary}: workflow-only appendix handoff overview
aggregated at the reporting-role level when present in the bundle.
\item \code{selection_handoff_role_section_summary}: workflow-only appendix handoff
overview aggregated at the reporting-role by appendix-section level when
present in the bundle.
\item \code{selection_summary}, \code{selection_table_summary},
\code{selection_table_preset_summary}, \code{selection_role_summary},
\code{selection_section_summary}, and \code{selection_catalog}: preset-filtered
appendix selection surfaces when workflow-only handoff tables are embedded
in the bundle.
\item \code{reporting_map}: where to go next for plotting, APA formatting, and export.
\item \code{notes}: carried forward source-level caveats from the originating summary.
}
}

\section{Typical workflow}{

\enumerate{
\item Build \code{bundle <- build_summary_table_bundle(summary(...))}.
\item Run \code{summary(bundle)} to see reporting coverage.
\item Use \code{plot(bundle, type = "table_rows")} or
\code{plot(bundle, type = "numeric_profile", which = ...)} for quick QC.
}
}

\examples{
\donttest{
toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score",
                method = "JML", maxit = 30)
bundle <- build_summary_table_bundle(fit)
summary(bundle)
}
}
\seealso{
\code{\link[=build_summary_table_bundle]{build_summary_table_bundle()}}, \code{\link[=apa_table]{apa_table()}}, \code{\link[=plot]{plot()}}
}
