get_edge_count_w_multiedge: Get count of edge definitions where multiple edges occur

View source: R/get_edge_count_w_multiedge.R

get_edge_count_w_multiedgeR Documentation

Get count of edge definitions where multiple edges occur

Description

Get a count of the number of edge definitions (e.g, 1 -> 2) where there are multiple edges (i.e., more than 1 edge of that definition, having distinct edge ID values). So, for example, if there are 2 edge definitions in the graph that involve 6 separate edge IDs (3 such edge IDs for each of the pairs of nodes), the count will be 2.

Usage

get_edge_count_w_multiedge(graph)

Arguments

graph

A graph object of class dgr_graph.

Value

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 edge
# definitions (e.g., `4` -> `1`) where
# there are multiple edges (i.e.,
# distinct edges with separate edge
# ID values)
graph %>% get_edge_count_w_multiedge()


DiagrammeR documentation built on June 22, 2024, 11:21 a.m.