Skip to contents

Provides a comprehensive summary of a gradient flow structure including information about local extrema, basins, trajectories, cells, and Jaccard indices between basins.

Usage

# S3 method for class 'ggflow'
summary(object, ...)

Arguments

object

An object of class "ggflow".

...

Additional arguments (currently ignored).

Value

An object of class "summary.ggflow" containing:

n_extrema

Total number of extrema

n_maxima

Number of local maxima

n_minima

Number of local minima

maxima

Data frame with information about local maxima

minima

Data frame with information about local minima

n_trajectories

Number of trajectories (if available)

trajectory_types

Table of trajectory type counts

avg_trajectory_length

Average trajectory length

connectivity

Matrix showing min-max connections

n_cells

Number of gradient flow cells

cell_sizes

Summary statistics of cell sizes

n_ascending_basins

Number of ascending basins

n_descending_basins

Number of descending basins

ascending_basins_jaccard_index

Jaccard similarity matrix for ascending basins

descending_basins_jaccard_index

Jaccard similarity matrix for descending basins

Examples

if (FALSE) { # \dontrun{
flow <- construct.graph.gradient.flow(adj.list, weight.list, y, scale)
summary(flow)
} # }