summary.circular_scan: Summary Method for circular_scan Objects

In treeSS: Tree-Spatial Scan Statistic for Cluster Detection

Summary Method for circular_scan Objects

Description

Prints the same fields as 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.

Usage

## S3 method for class 'circular_scan'
summary(object, ...)

Arguments

object	An object of class "circular_scan".
...	Further arguments passed to print.circular_scan(). In particular, max_show controls how many region IDs of the most-likely cluster are printed in full before truncating with "... and N more"; see print.circular_scan for details.

Value

Invisibly returns object (the input object of class "circular_scan"), unchanged. Called for the side effect of printing the same fields as print.circular_scan(), followed by a numeric summary (min, quartiles, median, mean, max) of the simulated log-likelihood-ratio distribution under the null.

treeSS documentation built on May 16, 2026, 1:08 a.m.