print.circular_scan: Print Method for circular_scan Objects

In treeSS: Tree-Spatial Scan Statistic for Cluster Detection

Print Method for circular_scan Objects

Description

Print Method for circular_scan Objects

Usage

## S3 method for class 'circular_scan'
print(x, max_show = 10L, ...)

Arguments

x	An object of class "circular_scan".
max_show	Integer. Maximum number of region IDs to display in full before truncating with "... and N more". The default of 10L keeps console output compact for large clusters; set max_show = -1L (or any value larger than the cluster size) to print every region. Mirrors the convention used by tibble for printing wide tables.
...	Further arguments passed to or from other methods.

Value

Invisibly returns x (the input object of class "circular_scan"), unchanged. Called for the side effect of printing a human-readable summary of the scan result to the console: the total cases and population, the number of regions scanned, the number of Monte Carlo simulations, and the contents of the most likely cluster (region IDs, cases, expected count, population, relative risk, log-likelihood ratio, and p-value).

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