summary.IkNN: Summarize IkNN Graph Object

In dgraphs: Data-Derived Graph Construction Utilities

Summarize IkNN Graph Object

Description

Prints a summary of an IkNN graph object, including the number of vertices, edges, and pruning statistics.

Usage

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

Arguments

object	An object of class "IkNN", typically output from create.single.iknn.graph()
...	Additional arguments passed to summary().

Value

Invisibly returns NULL while printing summary information to the console

Examples

graph <- list(
  pruned_adj_list = list(c(2L, 3L), c(1L, 3L), c(1L, 2L)),
  n_edges = 3L,
  n_pruned_edges = 2L,
  n_removed_edges = 1L,
  edge_reduction_ratio = 1 / 3
)
class(graph) <- c("IkNN", "list")

summary(graph)

dgraphs documentation built on Aug. 21, 2026, 1:08 a.m.