DiagrammeR (version 0.8.4)

get_selection: Get the current selection available in a graph object

Description

Get the current selection of nodes or edges from a graph object of class dgr_graph.

Usage

get_selection(graph)

Arguments

graph

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

Value

a vector with the current selection of nodes or edges.

Examples

library(magrittr)

# Create a simple graph
graph <-
  create_graph() %>%
  add_node_df(create_nodes(1:6)) %>%
  add_edge("1", "2") %>%
  add_edge("1", "3") %>%
  add_edge("3", "4") %>%
  add_edge("4", "5") %>%
  add_edge("4", "6")

# Select node `4`, then select all nodes a
# distance of 1 away from node `4`, and finally
# return the selection of nodes as a vector object
graph %>%
  select_nodes(nodes = "4") %>%
  select_nodes_in_neighborhood(
    node = "4", distance = 1) %>%
  get_selection
#> [1] "4" "5" "6" "3"

# Select edges associated with node `4` and return
# the selection of edges
graph %>%
  select_edges_by_node_id(4) %>%
  get_selection
#> [1] "4 -> 5" "4 -> 6" "3 -> 4"