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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
#' Render a graph available in a series
#'
#' @description
#'
#' Using a graph series object of type `dgr_graph_1D`, either render graph in
#' the Viewer or output in various formats.
#'
#' @param graph_series A graph series object of type `dgr_graph_1D`.
#' @param graph_no The index of the graph in the graph series.
#' @param output A string specifying the output type; `graph` (the default)
#' renders the graph using the [grViz()] function and `visNetwork` renders the
#' graph using the [visnetwork()] function.
#' @param width An optional parameter for specifying the width of the resulting
#' graphic in pixels.
#' @param height An optional parameter for specifying the height of the
#' resulting graphic in pixels.
#' @examples
#' \dontrun{
#' # 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)
#'
#' # View the second graph in
#' # the series in the Viewer
#' render_graph_from_graph_series(
#' graph_series = series,
#' graph_no = 2)
#' }
#'
#' @family Display and Save
#'
#' @export
render_graph_from_graph_series <- function(
graph_series,
graph_no,
output = "graph",
width = NULL,
height = NULL
) {
# Stop function if no graphs are available
if (is.null(graph_series$graphs)) {
cli::cli_abort(
"There are no graphs in this graph series.")
}
# Stop function if `graph_no` is out of range
if (!(graph_no %in% 1:count_graphs_in_graph_series(graph_series))) {
cli::cli_abort(
"The index chosen doesn't correspond to that of a graph in the series.")
}
# Extract the specified graph from the series
graph <- graph_series$graphs[[graph_no]]
render_graph(
graph = graph,
output = output,
width = width,
height = height)
}
|
