deselect_edges: Deselect any selected edges in a graph

View source: R/deselect_edges.R

deselect_edgesR Documentation

Deselect any selected edges in a graph

Description

Deselect edges in a graph object of class dgr_graph.

Usage

deselect_edges(graph, edges)

Arguments

graph

A graph object of class dgr_graph.

edges

A vector of edge IDs that should be deselected.

Value

A graph object of class dgr_graph.

Examples

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

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

# Verify that an edge selection
# has been made
graph %>% get_selection()

# Deselect edge `1`
graph <-
  graph %>%
  select_edges_by_edge_id(
    edges = c(1, 3)) %>%
  deselect_edges(edges = 1)

# Verify that the edge selection
# has been made for edges `1` and
# `3` and that edge `1` has been
# deselected (leaving only `3`)
graph %>% get_selection()


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