print.iterative_scan: Print Method for iterative_scan Objects

In treeSS: Tree-Spatial Scan Statistic for Cluster Detection

Print Method for iterative_scan Objects

Description

Print Method for iterative_scan Objects

Usage

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

Arguments

x	An object of class "iterative_scan".
max_show	Integer. Accepted for API consistency with print.treespatial_scan(), print.tree_scan(), and print.circular_scan(). Currently the only field affected is the per-iteration leaf_ids column of x$clusters, which is omitted from the printed table by default to keep the summary compact; pass max_show = -1L to include both leaf_ids and region_ids in the printed table.
...	Further arguments passed to or from other methods.

Value

Invisibly returns x (the input object of class "iterative_scan"), unchanged. Called for the side effect of printing a human-readable summary of the iterative scan result to the console: the scan type, the number of iterations performed, the significance threshold (applied to Holm-Bonferroni adjusted p-values), the number of significant clusters after correction, and a per-iteration table of detected clusters.

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