DiagrammeR (version 0.8.4)

trav_both: Traverse from one or more selected nodes to predecessors and successors, irrespective of edges, creating a new node selection

Description

From a graph object of class dgr_graph move toward both predecessor and successor nodes from one or more nodes present in a selection. The current nodes in the selection are replaced with those nodes traversed to.

Usage

trav_both(graph, node_attr = NULL, match = NULL)

Arguments

graph

a graph object of class dgr_graph that is created using create_graph.

node_attr

an optional character vector of node attribute values for filtering the node ID values returned.

match

an option to provide a logical expression with a comparison operator (>, <, ==, or !=) followed by a number for numerical filtering, or, a character string for filtering the edges returned through string matching.

Value

a graph object of class dgr_graph.

Examples

library(magrittr)

# Create a graph
graph <-
create_graph() %>%
  add_n_nodes(3) %>%
  add_edge(1, 2) %>%
  add_edge(2, 3)

# Starting at node `2`, traverse to nodes `1` and
# `2` with `trav_both()` (where the traversal leads
# to any connected nodes, regardless of edge
# direction); store the traversed locations as a
# selection in the graph object
graph <-
  graph %>%
  select_nodes_by_id(2) %>%
  trav_both

# Verify that the selection has been made by using
# the `get_selection()` function
get_selection(graph)
#> [1] "3" "1"

# Modify the graph by adding `type` values for
# nodes `1` and `3`
graph <-
  graph %>%
  clear_selection %>%
  select_nodes_by_id(1) %>%
  set_node_attrs_ws(
    node_attr = "type", value = "a") %>%
  clear_selection %>%
  select_nodes_by_id(3) %>%
  set_node_attrs_ws(
    node_attr = "type", value = "z") %>%
  clear_selection

# When traversing from node `2` to both `1` and `3`,
# you can set a condition that determines whether
# such traversal is permitted; in this case the
# condition is to traverse only to nodes where
# the type value is set to `a` (since node `3` has
# its `type` set to `z`, so, a traversal to `1`
# proceeds but there will be no traversal to `3`)
graph %>%
  select_nodes_by_id(2) %>%
  trav_both("type", "a") %>%
  get_selection
#> [1] "1"

# We can also set traversal conditions to satisfy
# numeric comparisons... the graph will be first
# modified
graph <-
  graph %>%
  set_node_attrs(1, "value", 3.4) %>%
  set_node_attrs(2, "value", 6.7) %>%
  set_node_attrs(3, "value", 9.1)