print.tree_scan: Print Method for tree_scan Objects

In treeSS: Tree-Spatial Scan Statistic for Cluster Detection

Print Method for tree_scan Objects

Description

Print Method for tree_scan Objects

Usage

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

Arguments

x	An object of class "tree_scan".
max_show	Integer. Maximum number of leaf IDs to display in full before truncating with "... and N more". The default of 10L keeps console output compact when a node spans hundreds or thousands of leaves (such as the root of a deep tree); set max_show = -1L to print every leaf.
...	Further arguments passed to or from other methods.

Value

Invisibly returns x (the input object of class "tree_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 tree nodes, the number of Monte Carlo simulations, the contents of the most likely cluster (node ID, leaf IDs, cases, expected count, log-likelihood ratio, and p-value), and the top significant cuts at the chosen significance threshold.

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