% Generated manually for treeSS 0.1.44; keep in sync with roxygen comments
% in R/print.R. devtools::document() will regenerate this file from those
% comments without manual intervention.
\name{summary.circular_scan}
\alias{summary.circular_scan}
\title{Summary Method for circular_scan Objects}
\usage{
\method{summary}{circular_scan}(object, ...)
}
\arguments{
\item{object}{An object of class \code{"circular_scan"}.}

\item{...}{Further arguments passed to \code{print.circular_scan()}.
In particular, \code{max_show} controls how many region IDs of
the most-likely cluster are printed in full before truncating
with \code{"... and N more"}; see
\code{\link{print.circular_scan}} for details.}
}
\value{
Invisibly returns \code{object} (the input object of
class \code{"circular_scan"}), unchanged. Called for the side
effect of printing the same fields as
\code{print.circular_scan()}, followed by a numeric summary
(min, quartiles, median, mean, max) of the simulated
log-likelihood-ratio distribution under the null.
}
\description{
Prints the same fields as \code{print.circular_scan()}, followed
by a numeric summary of the simulated log-likelihood-ratio
distribution under the null. Useful for checking that the Monte
Carlo replicates produced a reasonable spread relative to the
observed test statistic.
}
