Skip to contents

Print Method for Gradient Flow Graph Objects

Source: R/gflow_graph.R
print.gflow_graph.Rd

Prints a summary of a gradient flow graph object.

Usage

# S3 method for class 'gflow_graph'
print(x, ...)

Arguments

x

An object of class "gflow_graph" as created by construct.gflow.graph.

...

Additional arguments (currently unused).

Value

Invisibly returns the input object x. This function is called for its side effect of printing a summary to the console.

Examples

gflow.graph <- list(
  adjacency.list = list(c(3L), integer(0), c(1L)),
  weight.list = list(0.8, numeric(0), 0.8),
  intersection.matrix = matrix(c(4, 0, 2,
                                 0, 3, 0,
                                 2, 0, 5),
                               nrow = 3, byrow = TRUE),
  basin.metadata = data.frame(
    label = c("m1", "m2", "M1"),
    type = c("ascending", "ascending", "descending"),
    size = c(4, 3, 5),
    extremum.vertex = c(2L, 5L, 3L),
    extremum.value = c(0.7, 1.1, 3.2)
  ),
  n.ascending = 2L,
  n.descending = 1L,
  edge.type = "all",
  min.intersection = 1L
)
class(gflow.graph) <- "gflow_graph"

gflow.graph