Skip to contents

Rename an edge attribute

Source: R/rename_edge_attrs.R
rename_edge_attrs.Rd

Within a graph's internal edge data frame (edf), rename an existing edge attribute.

Usage

rename_edge_attrs(graph, edge_attr_from, edge_attr_to)

Arguments

graph

A graph object of class dgr_graph.

edge_attr_from

The name of the edge attribute that will be renamed.

edge_attr_to

The new name of the edge attribute column identified in edge_attr_from.

Value

A graph object of class dgr_graph.

See also

Other edge creation and removal: add_edge(), add_edge_clone(), add_edge_df(), add_edges_from_table(), add_edges_w_string(), add_forward_edges_ws(), add_reverse_edges_ws(), copy_edge_attrs(), create_edge_df(), delete_edge(), delete_edges_ws(), delete_loop_edges_ws(), drop_edge_attrs(), edge_data(), join_edge_attrs(), mutate_edge_attrs(), mutate_edge_attrs_ws(), recode_edge_attrs(), rescale_edge_attrs(), rev_edge_dir(), rev_edge_dir_ws(), set_edge_attr_to_display(), set_edge_attrs(), set_edge_attrs_ws()

Examples

# Create a random graph using the
# `add_gnm_graph()` function
graph <-
  create_graph() %>%
  add_gnm_graph(
    n = 5,
    m = 8,
    set_seed = 23) %>%
  set_edge_attrs(
    edge_attr = color,
    values = "green")

# Get the graph's internal edf
# to show which edge attributes
# are available
graph %>% get_edge_df()
#>   id from to  rel color
#> 1  1    1  3 <NA> green
#> 2  2    2  1 <NA> green
#> 3  3    2  5 <NA> green
#> 4  4    2  3 <NA> green
#> 5  5    3  2 <NA> green
#> 6  6    3  5 <NA> green
#> 7  7    3  4 <NA> green
#> 8  8    5  3 <NA> green

# Rename the `color` node
# attribute as `weight`
graph <-
  graph %>%
  rename_edge_attrs(
    edge_attr_from = color,
    edge_attr_to = labelfontcolor)

# Get the graph's internal
# edf to show that the edge
# attribute had been renamed
graph %>% get_edge_df()
#>   id from to  rel labelfontcolor
#> 1  1    1  3 <NA>          green
#> 2  2    2  1 <NA>          green
#> 3  3    2  5 <NA>          green
#> 4  4    2  3 <NA>          green
#> 5  5    3  2 <NA>          green
#> 6  6    3  5 <NA>          green
#> 7  7    3  4 <NA>          green
#> 8  8    5  3 <NA>          green