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
|
#' Get the count of multiple edges
#'
#' @description
#'
#' Get a count of the number of multiple edges in the graph. Included in the
#' count is the number of separate edges that share the same edge definition
#' (i.e., same pair of nodes) across the entire graph. So, for example, if there
#' are 2 edge definitions in the graph that involve 6 separate edge IDs, the
#' count will be `4`.
#'
#' @inheritParams render_graph
#'
#' @return A vector with a single, numerical value.
#'
#' @examples
#' # Create a node data frame (ndf)
#' ndf <-
#' create_node_df(
#' n = 5,
#' label = TRUE)
#'
#' # Create an edge data frame (edf)
#' edf <-
#' create_edge_df(
#' from = c(1, 4, 4, 3, 5, 1, 3, 4),
#' to = c(4, 1, 1, 2, 2, 2, 2, 1))
#'
#' # Create a graph with the ndf and edf
#' graph <-
#' create_graph(
#' nodes_df = ndf,
#' edges_df = edf)
#'
#' # Get the total number of multiple
#' # edges (those edges that share an
#' # edge definition) in the graph
#' graph %>% get_multiedge_count()
#'
#' @export
get_multiedge_count <- function(graph) {
# Validation: Graph object is valid
check_graph_valid(graph)
# Validation: Graph contains edges
check_graph_contains_edges(graph)
# Check for the number of multiple edges
# regardless of which definitions these
# edges have
multiedge_count <-
(graph$edges_df %>%
nrow()) -
(graph$edges_df %>%
dplyr::distinct(from, to) %>%
nrow())
multiedge_count
}
|
