DiagrammeR (version 0.8.4)

remove_from_series: Remove a graph from a graph series

Description

Remove a single graph object from an set of graph objects contained within a graph series object.

Usage

remove_from_series(graph_series, index = "last")

Arguments

graph_series

a graph series object from which the graph object will be removed.

index

the index of the graph object to be removed from the graph series object.

Value

a graph series object of type dgr_graph_1D.

Examples

library(magrittr)

# Create three graphs
graph_1 <-
  create_graph(
    graph_name = "keep") %>%
  add_node("a") %>%
  add_node("b") %>%
  add_node("c") %>%
  add_edge("a", "c") %>%
  add_edge("a", "b") %>%
  add_edge("b", "c")

graph_2 <-
  graph_1 %>%
  add_node("d") %>%
  add_edge("d", "c") %>%
  set_graph_name("remove")

graph_3 <-
  graph_2 %>%
  add_node("e") %>%
  add_edge("e", "b") %>%
  set_graph_name("keep")

# Create an empty graph series and add
# the graphs
series <-
  create_series() %>%
  add_to_series(graph_1, .) %>%
  add_to_series(graph_2, .) %>%
  add_to_series(graph_3, .)

# Remove the second graph (with the name `remove`)
# from the graph series
series <-
  remove_from_series(
    graph_series = series,
    index = 2)

# Use `series_info()` function to ensure that
# the graph with the name `remove` was removed
series_info(series)
#>   graph name date_time   tz nodes edges directed
#> 1     1 keep      <NA> <NA>     3     3     TRUE
#> 2     2 keep      <NA> <NA>     5     5     TRUE