Summarize a Canonical Basin Complex

Usage

# S3 method for class 'basin_complex'
summary(
  object,
  rank.by = c("auto", "primary.support.mass", "raw.allocated.mass",
    "retained.support.mass", "raw.support.mass", "primary.support.size",
    "retained.support.size", "raw.support.size", "extremum.value"),
  top.k.max = Inf,
  top.k.min = Inf,
  include.unretained = FALSE,
  include.vertex.lists = FALSE,
  ...
)

# S3 method for class 'summary.basin_complex'
print(x, ..., n = 5L, digits = 3L)

Arguments

object: A canonical basin_complex.
rank.by: Ranking measure. "auto" resolves independently for maximum and minimum directions from usable canonical mass and support measures. Explicit "extremum.value" ranks maxima from high to low and minima from low to high; it is not an automatic fallback.
top.k.max: Maximum number of ranked maximum basins to return.
top.k.min: Maximum number of ranked minimum basins to return.
include.unretained: Include basins removed by canonical refinement.
include.vertex.lists: Include list columns containing vertex supports.
...: Reserved for S3 compatibility.
x: A summary object for printing, or a canonical basin complex for plotting.
n: Maximum ranked rows to print per direction. Full tables remain in the returned summary; use Inf to print all returned rows.
digits: Significant digits in printed ranked tables.

Value

A summary.basin_complex containing aggregate counts, ranked direction-specific tables, ranking availability, column definitions, mass provenance, build identity, diagnostics, and a coverage table. Coverage reports unique vertices in raw membership, retained supports, and current nonmissing assignments per direction, independently of Top-K ranking. n.assignments remains the number of assignment rows, including unavailable labels; coverage$assigned.vertices counts actual labels.