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

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

\item{top_n}{Maximum numeric columns shown in \code{numeric_profile}.}

\item{...}{Reserved for generic compatibility.}
}
\value{
An object of class \code{summary.apa_table}.
}
\description{
Summarize an APA/FACETS table object
}
\details{
Compact summary helper for QA of table data before manuscript export.
}
\section{Interpreting output}{

\itemize{
\item \code{overview}: table size/composition and missingness.
\item \code{numeric_profile}: quick distribution summary of numeric columns.
\item \code{caption}/\code{note}: text metadata readiness.
}
}

\section{Typical workflow}{

\enumerate{
\item Build table with \code{\link[=apa_table]{apa_table()}}.
\item Run \code{summary(tbl)} and inspect \code{overview}.
\item Use \code{\link[=plot.apa_table]{plot.apa_table()}} for quick numeric checks if needed.
}
}

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