1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
#' Add graph object to a graph series object
#'
#' @description
#'
#' Add a graph object to an extant graph series object for storage of multiple
#' graphs across a sequential or temporal one-dimensional array.
#'
#' @param graph_series A graph series object to which the graph object will be
#' added.
#' @param graph A graph object to add to the graph series object.
#'
#' @return A graph series object of type `dgr_graph_1D`.
#'
#' @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)
#'
#' # Count the number of graphs
#' # in the graph series
#' series %>%
#' count_graphs_in_graph_series()
#'
#' @export
add_graph_to_graph_series <- function(
graph_series,
graph
) {
# Validation: Graph object is valid
rlang::check_required(graph)
check_graph_valid(graph)
# Get the series type
series_type <- graph_series$series_type
# Stop function if graph series type is not valid
rlang::arg_match0(series_type, c("sequential", "temporal"), arg_nm = "graph series")
# Add graph to series
graph_series$graphs[[length(graph_series$graphs) + 1]] <- graph
graph_series
}
|
