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

\item{top_n}{Number of populated clusters to profile when attached data 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 containing cluster sizes, optional cluster-level descriptive summaries, and,
when available, assignment-certainty summaries.
}
\description{
Summarize a representative clustering for training data or new observations.
}
\details{
If score or probability matrices are attached, certainty is summarized by the rowwise maxima
\eqn{\max_k p_{ik}}, which quantify how strongly each observation is assigned to its selected
cluster. When the labels object also carries attached training or prediction data, the summary
includes descriptive mean/sd profiles for the first populated clusters.
}
\seealso{
\code{\link[=predict.dpmixgpd_cluster_fit]{predict.dpmixgpd_cluster_fit()}}, \code{\link[=plot.dpmixgpd_cluster_labels]{plot.dpmixgpd_cluster_labels()}},
\code{\link[=summary.dpmixgpd_cluster_fit]{summary.dpmixgpd_cluster_fit()}}.

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_fit}()},
\code{\link{summary.dpmixgpd_cluster_psm}()}
}
\concept{cluster workflow}
