1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/deselect_edges.R
3\name{deselect_edges}
4\alias{deselect_edges}
5\title{Deselect any selected edges in a graph}
6\usage{
7deselect_edges(graph, edges)
8}
9\arguments{
10\item{graph}{A graph object of class \code{dgr_graph}.}
11
12\item{edges}{A vector of edge IDs that should be deselected.}
13}
14\value{
15A graph object of class \code{dgr_graph}.
16}
17\description{
18Deselect edges in a graph object of class \code{dgr_graph}.
19}
20\examples{
21# Create a graph with
22# a single path
23graph <-
24  create_graph() \%>\%
25  add_path(n = 5)
26
27# Select edges with IDs `1`
28# and `3`
29graph <-
30  graph \%>\%
31  select_edges_by_edge_id(
32    edges = c(1, 3))
33
34# Verify that an edge selection
35# has been made
36graph \%>\% get_selection()
37
38# Deselect edge `1`
39graph <-
40  graph \%>\%
41  select_edges_by_edge_id(
42    edges = c(1, 3)) \%>\%
43  deselect_edges(edges = 1)
44
45# Verify that the edge selection
46# has been made for edges `1` and
47# `3` and that edge `1` has been
48# deselected (leaving only `3`)
49graph \%>\% get_selection()
50
51}
52