Generates a detailed summary of a gradient flow graph, including vertex information, edge statistics, and connectivity properties.
Usage
# S3 method for class 'gflow_graph'
summary(object, ...)Arguments
- object
An object of class
"gflow_graph"as created byconstruct.gflow.graph.- ...
Additional arguments (currently unused).
Value
A list containing summary statistics:
- n.vertices
Total number of vertices (basins).
- n.ascending
Number of ascending basins.
- n.descending
Number of descending basins.
- n.edges
Total number of edges.
- edge.type
Type of edges included.
- degree.stats
Summary statistics of vertex degrees.
- basin.size.stats
Summary statistics of basin sizes.
- intersection.stats
Summary statistics of nonzero intersections.
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"
summary(gflow.graph)