DiagrammeR (version 0.8.4)

create_series: Create a graph series object

Description

Create a graph series object for the storage of multiple graphs across a sequential or temporal one-dimensional array.

Usage

create_series(graph = NULL, series_name = NULL, series_type = "sequential", series_scripts = NULL)

Arguments

graph

a graph object to add to the new graph series object.

series_name

an optional name to ascribe to the series.

series_type

either a sequential type (the default) or a temporal type (which requires date-time strings and time zone codes to be supplied).

series_scripts

a vector of R scripts or paths to R scripts.

Value

a graph series object of type dgr_graph_1D.

Examples

library(magrittr)

# Create three graphs
graph_1 <-
  create_graph() %>%
  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")

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

# 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, .)

# Count the number of graphs in the graph series
graph_count(series)
#> [1] 3