is_edge_mutual: Is the edge mutual with another edge?

View source: R/is_edge_mutual.R

is_edge_mutualR Documentation

Is the edge mutual with another edge?

Description

Determines whether an edge definition has a mutual analogue with the same node pair.

Usage

is_edge_mutual(graph, edge)

Arguments

graph

A graph object of class dgr_graph.

edge

A numeric edge ID value.

Value

A logical value.

Examples

# Create a graph that has mutual
# edges across some node pairs
graph <-
  create_graph() %>%
  add_path(n = 4) %>%
  add_edge(
    from = 4,
    to = 3) %>%
  add_edge(
    from = 2,
    to = 1)

# Get the graph's internal
# edge data frame
graph %>% get_edge_df()

# Determine if edge `1` has
# a mutual edge
graph %>%
  is_edge_mutual(edge = 1)

# Determine if edge `2` has
# a mutual edge
graph %>%
  is_edge_mutual(edge = 2)


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