clear_selection: Clear an active selection of nodes or edges

View source: R/clear_selection.R

clear_selectionR Documentation

Clear an active selection of nodes or edges

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.

Value

A graph object of class dgr_graph.

Examples

# Create a graph with
# a single path
graph <-
  create_graph() %>%
  add_path(n = 5)

# Select nodes with IDs `1`
# and `3`
graph <-
  graph %>%
  select_nodes(
    nodes = c(1, 3))

# Verify that a node selection
# has been made
graph %>% get_selection()

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

# Verify that the node
# selection has been cleared
graph %>% get_selection()


rich-iannone/DiagrammeR documentation built on Feb. 5, 2024, 8 a.m.