% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/mcml.R
\name{summary.mcml}
\alias{summary.mcml}
\title{Summary Method for mcml}
\usage{
\method{summary}{mcml}(object, ...)
}
\arguments{
\item{object}{An \code{mcml} object.}

\item{...}{Unsupported. Supplying unused arguments raises an error.}
}
\value{
A tidy data frame with one row per cluster and columns
\code{cluster}, \code{size}, \code{within_total}, \code{between_out},
\code{between_in}. For undirected macro networks the in/out split is
not meaningful, so \code{between_out} reports total incident weight
and \code{between_in} is \code{NA}. The data frame is returned
silently \emph{without} printing the full object -- call
\code{print(object)} explicitly if you want the verbose dump.
}
\description{
Summary Method for mcml
}
\examples{
seqs <- data.frame(V1 = c("A","B","C","A"), V2 = c("B","C","A","B"))
clusters <- list(G1 = c("A","B"), G2 = c("C"))
cs <- build_mcml(seqs, clusters)
summary(cs)
\donttest{
seqs <- data.frame(
  T1 = c("A","B","A"), T2 = c("B","C","B"),
  T3 = c("C","A","C"), T4 = c("A","B","A")
)
clusters <- c("Alpha", "Beta", "Alpha")
cs <- build_mcml(seqs, clusters, type = "raw")
summary(cs)
}

}
