Get information on a graph series

Source: R/get_graph_series_info.R

Obtain a data frame with information on the graphs within a graph series.

get_graph_series_info(graph_series)

Arguments

graph_series

A graph series object of type dgr_graph_1D.

Value

A data frame containing information on the graphs within the supplied graph series.

Examples

# Create three graphs
graph_1 <-
  create_graph() %>%
  add_path(n = 4)

graph_2 <-
  create_graph() %>%
  add_cycle(n = 5)

graph_3 <-
  create_graph() %>%
  add_star(n = 6)

# Create an empty graph series
# and add the graphs
series <-
  create_graph_series() %>%
  add_graph_to_graph_series(
    graph = graph_1) %>%
  add_graph_to_graph_series(
    graph = graph_2) %>%
  add_graph_to_graph_series(
    graph = graph_3)

# Get information on the graphs in the series
series %>% get_graph_series_info()
#>   graph           name           date_time      tz nodes edges directed
#> 1     1 graph_UyR63KxF 2025-08-26 15:07:04 Etc/UTC     4     3     TRUE
#> 2     2 graph_eySz3BP7 2025-08-26 15:07:04 Etc/UTC     5     5     TRUE
#> 3     3 graph_G7a9jw4f 2025-08-26 15:07:04 Etc/UTC     6     5     TRUE