summary.treespatial_scan: Summary Method for treespatial_scan Objects

In treeSS: Tree-Spatial Scan Statistic for Cluster Detection

Summary Method for treespatial_scan Objects

Description

Prints the same fields as print.treespatial_scan(), followed by the top-10 branches by total case count and a numeric summary of the simulated log-likelihood-ratio distribution under the null. Useful for diagnosing how heavily one branch of the tree dominates the dataset and whether the observed maximum LR is a clear outlier against the simulated null.

Usage

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

Arguments

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

Value

Invisibly returns object (the input object of class "treespatial_scan"), unchanged. Called for the side effect of printing the same fields as print.treespatial_scan(), followed by the top-10 branches by total case count and 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.