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
|
#' Count graphs in a graph series object
#'
#' @description
#'
#' Counts the total number of graphs in a graph series object.
#'
#' @param graph_series A graph series object of type `dgr_graph_1D`
#'
#' @return A numeric vector representing a count of graphs in a graph series
#' object.
#'
#' @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
count_graphs_in_graph_series <- function(graph_series) {
if (inherits(graph_series, "dgr_graph_1D")) {
if (is.null(graph_series$graphs)) {
return(0L)
}
return(length(graph_series$graphs))
}
}
|