% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cluster.R
\name{summary.dpmixgpd_cluster_fit}
\alias{summary.dpmixgpd_cluster_fit}
\title{Summarize a cluster fit}
\usage{
\method{summary}{dpmixgpd_cluster_fit}(
  object,
  burnin = NULL,
  thin = NULL,
  top_n = 5L,
  order_by = c("size", "label"),
  vars = NULL,
  ...
)
}
\arguments{
\item{object}{A cluster fit.}

\item{burnin}{Number of initial posterior draws to discard.}

\item{thin}{Keep every \code{thin}-th posterior draw.}

\item{top_n}{Number of populated clusters to profile when descriptive summaries are available.}

\item{order_by}{Ordering rule for descriptive cluster profiles:
\itemize{
\item \code{"size"}: decreasing cluster size
\item \code{"label"}: ascending cluster label
}}

\item{vars}{Optional character vector of numeric columns to summarize within each cluster.}

\item{...}{Unused.}
}
\value{
Summary list with the number of retained clusters, cluster sizes, optional
cluster-level descriptive summaries, and the burn-in/thinning settings used to construct the
summary.
}
\description{
Summarize the posterior clustering induced by the Dahl representative partition.
}
\details{
This summary is based on \code{\link[=predict.dpmixgpd_cluster_fit]{predict.dpmixgpd_cluster_fit()}} with \code{type = "label"}. The reported
cluster count \eqn{K^*} is the number of unique labels in the representative partition rather
than the number of components available in the truncated sampler.
}
\seealso{
\code{\link[=predict.dpmixgpd_cluster_fit]{predict.dpmixgpd_cluster_fit()}}, \code{\link[=plot.dpmixgpd_cluster_fit]{plot.dpmixgpd_cluster_fit()}},
\code{\link[=summary.dpmixgpd_cluster_labels]{summary.dpmixgpd_cluster_labels()}}.

Other cluster workflow: 
\code{\link{cluster_profiles}()},
\code{\link{dpmgpd.cluster}()},
\code{\link{dpmix.cluster}()},
\code{\link{plot.dpmixgpd_cluster_bundle}()},
\code{\link{predict.dpmixgpd_cluster_fit}()},
\code{\link{print.dpmixgpd_cluster_bundle}()},
\code{\link{print.dpmixgpd_cluster_fit}()},
\code{\link{print.dpmixgpd_cluster_labels}()},
\code{\link{print.dpmixgpd_cluster_psm}()},
\code{\link{summary.dpmixgpd_cluster_bundle}()},
\code{\link{summary.dpmixgpd_cluster_labels}()},
\code{\link{summary.dpmixgpd_cluster_psm}()}
}
\concept{cluster workflow}
