% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/S3summary.R
\name{summary}
\alias{summary}
\alias{summary.good.of.fit}
\alias{summary.MIRT}
\alias{summary.MGPCM}
\alias{summary.MGGUM}
\alias{summary.FCMIRT}
\alias{summary.FCDCM}
\alias{summary.FCGDINA}
\alias{summary.FCGGUM}
\alias{summary.TIRT}
\title{S3 Methods: summary}
\usage{
\method{summary}{good.of.fit}(object, digits = 4, ...)

\method{summary}{MIRT}(object, digits = 4, ...)

\method{summary}{MGPCM}(object, digits = 4, ...)

\method{summary}{MGGUM}(object, digits = 4, ...)

\method{summary}{FCMIRT}(object, digits = 4, ...)

\method{summary}{FCDCM}(object, digits = 4, ...)

\method{summary}{FCGDINA}(object, digits = 4, ...)

\method{summary}{FCGGUM}(object, digits = 4, ...)

\method{summary}{TIRT}(object, digits = 4, ...)
}
\arguments{
\item{object}{An object of one of the following classes:
\itemize{
\item Fitted model objects: \code{"MIRT"}, \code{"MGPCM"},
\code{"MGGUM"}, \code{"FCMIRT"}, \code{"FCDCM"}, \code{"FCGGUM"},
\code{"FCGDINA"}, \code{"TIRT"}
\item Goodness-of-fit objects: \code{"good.of.fit"}
}}

\item{digits}{Number of decimal places for numeric output (default: 4).
Applied uniformly across all methods.}

\item{...}{Additional arguments passed to or from other methods (currently
ignored).}
}
\value{
Invisibly returns a structured list containing summary components.
The exact structure depends on the class of \code{object}. All returned
objects carry an appropriate S3 class (e.g., \code{"summary.MIRT"},
\code{"summary.good.of.fit"}) for use with corresponding \code{print}
methods.
}
\description{
Generates structured, comprehensive summaries of objects produced by the
\pkg{ForceChoice} package. This generic function dispatches to
class-specific methods that extract and organize key information including
model configurations, fit statistics, parameter estimates, and convergence
diagnostics. Designed for programmatic access and downstream reporting.
}
\details{
Each method returns a named list with class-specific components optimized
for structured access and formatted printing:

\describe{
\item{\strong{Fitted Model Objects}}{
Returns a \code{summary.<Class>} object with components:
\describe{
\item{\code{call}}{Original function call.}
\item{\code{model.info}}{List: \code{family}, \code{description},
\code{D}, \code{method}, and model-specific fields (\code{model},
\code{fc.type}, \code{dcm.type}, \code{I.states}, \code{N.block}).}
\item{\code{data.info}}{List: \code{N}, \code{I} or \code{B},
\code{response.type}.}
\item{\code{fit.stats}}{List: \code{LogLik}, \code{npar},
\code{AIC}, \code{BIC}.}
\item{\code{par.summary}}{Matrix: parameter summary (Min, Q1, Median,
Mean, Q3, Max) across items/statements/blocks for each parameter type.}
\item{\code{theta.summary}}{Matrix: person parameter summary per
dimension.}
\item{\code{Corr}}{Matrix: factor inter-trait correlation matrix
(where applicable).}
\item{\code{convergence}}{List: algorithm, batch counts, convergence
flags, latent grid length \code{L} (iStEM) or diagnostic note (Stan).}
\item{\code{digits}}{Numeric: precision used for formatting.}
}
Additional model-specific components:
\describe{
\item{\code{delta.summary}}{FCDCM only: higher-order delta parameters.}
\item{\code{classification}}{FCDCM only: observed attribute patterns,
mean maximum posterior.}
\item{\code{lambda.summary}}{TIRT only: factor loading summary.}
}
}

\item{\strong{Goodness-of-Fit Objects (\code{good.of.fit})}}{
Returns a \code{summary.good.of.fit} object with components:
\describe{
\item{\code{Sample_Size}, \code{Items}, \code{Response_Type},
\code{Parameters}, \code{Moments}, \code{LogLik},
\code{Deviance}}{Overview statistics.}
\item{\code{IC}}{Named vector: AIC, AICc, BIC, CAIC, SABIC, HQIC.}
\item{\code{M2}}{List: M2 statistic, df, p-value, RMSEA with CI.}
\item{\code{Residual_Fit}}{Named vector: SRMSR, RMSR, max
standardized residual.}
\item{\code{Comparative_Fit}}{Named vector: CFI, TLI, IFI.}
\item{\code{Pseudo_R2}}{Named vector: McFadden, Cox--Snell,
Nagelkerke, Aldrich--Nelson, Veall--Zimmermann.}
\item{\code{Local_Dependence}}{Named vector: Q3 mean, max, adjusted
max, P95.}
\item{\code{Classification}}{Named vector: posterior entropy,
max posterior.}
\item{\code{Null_Model}}{Named vector: null model LogLik, deviance,
M2, df.}
\item{\code{tables}}{List of data frames for formatted printing.}
}
}
}
}
\section{Methods (by class)}{
\itemize{
\item \code{summary(good.of.fit)}: Summary method for \code{good.of.fit} objects.
Extracts and structures all fit indices: information criteria,
limited-information M2, RMSEA, SRMSR, CFI/TLI/IFI, pseudo-\eqn{R^2},
local dependence (Yen's Q3), posterior classification, and null-model
diagnostics.

\item \code{summary(MIRT)}: Summary method for \code{MIRT} objects.
Multidimensional IRT (1PL--4PL): extracts binary-response model
configuration, fit statistics (LogLik, AIC, BIC), factor correlation
matrix, person and item parameter summaries, and convergence
diagnostics.

\item \code{summary(MGPCM)}: Summary method for \code{MGPCM} objects.
Multidimensional Generalized Partial Credit Model: polytomous
responses with category-specific step parameters.

\item \code{summary(MGGUM)}: Summary method for \code{MGGUM} objects.
Multidimensional Generalized Graded Unfolding Model: ideal-point
polytomous responses with discrimination (a), location (delta), and
threshold (tau) parameters.

\item \code{summary(FCMIRT)}: Summary method for \code{FCMIRT} objects.
Forced-Choice Multidimensional IRT: dominance model with sequential
ranking over item endorsement logits at the block level. Extracts
block configuration, FC type
(RANK/MOLE/PICK), and statement-level parameter summaries.

\item \code{summary(FCDCM)}: Summary method for \code{FCDCM} objects.
Forced-Choice Diagnostic Classification Model: higher-order trait with
exact marginalization over \eqn{2^D} attribute profiles. Extracts
DCM type (DINA/DINO), higher-order delta parameters, block eta
parameters, and posterior classification diagnostics.

\item \code{summary(FCGDINA)}: Summary method for \code{FCGDINA} objects.
Forced-Choice GDINA model: CDM item model (DINA/DINO/ACDM/GDINA) with
sequential forced-choice ranking over item endorsement logits.

\item \code{summary(FCGGUM)}: Summary method for \code{FCGGUM} objects.
Forced-Choice Generalized Graded Unfolding Model: ideal-point model
with sequential ranking over binary GGUM endorsement logits. Extracts
forced-choice block structure, unfolding parameters (a, delta, tau),
and convergence info.

\item \code{summary(TIRT)}: Summary method for \code{TIRT} objects.
Thurstonian IRT for Forced-Choice: pairwise probit comparison of latent
utility differences. Extracts statement loadings (lambda), uniquenesses
(psi2), pairwise gamma matrix, and factor correlations.

}}
