print.treespatial_scan: Print Method for treespatial_scan Objects

In treeSS: Tree-Spatial Scan Statistic for Cluster Detection

Print Method for treespatial_scan Objects

Description

Print Method for treespatial_scan Objects

Usage

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

Arguments

x	An object of class "treespatial_scan".
max_show	Integer. Maximum number of leaf IDs and region IDs to display in full before truncating with "... and N more". The default of 10L keeps console output compact when the most likely cluster spans many leaves (for example, when the root node maximises the likelihood ratio for an aggregated denominator) or many regions; set max_show = -1L to print every value. Mirrors the convention used by tibble.
...	Further arguments passed to or from other methods.

Value

Invisibly returns x (the input object of class "treespatial_scan"), unchanged. Called for the side effect of printing a human-readable summary of the scan result to the console: the total population, the number of regions and tree nodes, the number of Monte Carlo simulations, and the contents of the most likely cluster (tree node, leaf IDs, 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.