DiagrammeR (version 0.8.4)

clear_selection: Clear a selection of nodes or edges in a graph

Description

Clear the selection of nodes or edges within a graph object.

Usage

clear_selection(graph)

Arguments

graph

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

Value

a graph object of class dgr_graph.

Examples

# Create a simple graph
nodes <-
  create_nodes(
    nodes = c("a", "b", "c", "d"),
    type = "letter",
    label = TRUE,
    value = c(3.5, 2.6, 9.4, 2.7))

edges <-
  create_edges(
    from = c("a", "b", "c"),
    to = c("d", "c", "a"),
    rel = "leading_to")

graph <-
  create_graph(
    nodes_df = nodes,
    edges_df = edges)

# Select nodes "a" and "c"
graph <-
  select_nodes(
    graph = graph,
    nodes = c("a", "c"))

# Verify that a node selection has been made
get_selection(graph)
#> $nodes
#> [1] "a" "c"

# Clear the selection with `clear_selection()`
graph <- clear_selection(graph = graph)

# Verify that the node selection has been cleared
get_selection(graph)
#> [1] NA