Skip to contents

Plot a Canonical Basin Complex

Source: R/basin_complex.R
plot.basin_complex.Rd

Select an explicit analytical view or inspect the input field. Drawing coordinates never change the graph, field, or computed basins.

Usage

# S3 method for class 'basin_complex'
plot(
  x,
  xlab = "Vertex index",
  ylab = "Field",
  main = "Input scalar field",
  ...,
  view = c("field", "merge_tree", "assignment", "overlap"),
  direction = NULL,
  coordinates = NULL,
  stage = c("retained", "raw"),
  label.vertices = FALSE
)

Arguments

x

A canonical basin_complex.

xlab, ylab

Axis labels. Graph views default to coordinate column names.

main

Plot title. Construction status is always shown if not "ok".

...

Graphical parameters passed to the field/graph plot, or arguments to plot.basin.merge.tree() for the merge-tree view. Use main.tree, main.barcode, and field.label to customize merge-tree panels.

view

"field" (default, input field against vertex index), "merge_tree", "assignment", or "overlap" (number of containing basins).

direction

"max" or "min". Required for analytical views when both directions were constructed; otherwise the object's direction is used.

coordinates

Finite numeric n-by-2 drawing coordinates in graph vertex order, required for assignment and overlap views. If row names are supplied they must match the object's external vertex IDs in order.

stage

Support used by the overlap view: "retained" (default) or "raw". The assignment view always uses current primary assignments.

label.vertices

Show external vertex IDs on graph views.

Value

x, invisibly.

Details

A failed construction can only be plotted as an explicitly labeled input field, with a warning and diagnostic. Analytical views reject failed objects. Partial results are labeled and warn. The assignment view rejects unavailable assignment policies; a missing label is not treated as an inferred basin. Overlap counts describe support coverage, not uncertainty or probability. Filled circles have an assignment/support; crosses mark missing assignments or zero coverage. Plotting leaves the numerical object unchanged.

See also

summary.basin_complex(), get.basin.assignment(), get.basin.table(), plot.basin.merge.tree()