set_edge_attrs_ws {DiagrammeR} | R Documentation

## Set edge attributes with an edge selection

### Description

From a graph object of class `dgr_graph` or an edge data frame, set edge attribute properties for one or more edges.

Selections of edges can be performed using the following `select_...` functions: `select_edges()`, `select_last_edge()`, or `select_edges_by_node_id()`. Selections of edges can also be performed using the following traversal functions: `trav_out_edge()`, `trav_in_edge()`, or `trav_both_edge()`.

### Usage

    set_edge_attrs_ws(graph, edge_attr, value)

### Arguments

`graph` | a graph object of class `dgr_graph`.
`edge_attr` | the name of the attribute to set.
`value` | the value to be set for the chosen attribute for the edges in the current selection.

### Value

a graph object of class `dgr_graph`.

### Examples

    # Create a simple graph
    graph <-
      create_graph() %>%
      add_path(n = 6)

    # Select specific edges from
    # the graph and apply the edge
    # attribute `color = blue` to
    # those selected edges
    graph <-
      graph %>%
      select_nodes_by_id(nodes = 2:4) %>%
      trav_out_edge() %>%
      set_edge_attrs_ws(
        edge_attr = color,
        value = "blue")

    # Show the internal edge data
    # frame to verify that the
    # edge attribute has been set
    # for specific edges
    get_edge_df(graph)
    #>   id from to  rel color
    #> 1  1    1  2 <NA>  <NA>
    #> 2  2    2  3 <NA>  blue
    #> 3  3    3  4 <NA>  blue
    #> 4  4    4  5 <NA>  blue
    #> 5  5    5  6 <NA>  <NA>

[Package DiagrammeR version 0.9.2 Index]