Skip to contents

Drop an edge attribute column

Source: R/drop_edge_attrs.R
drop_edge_attrs.Rd

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

Usage

drop_edge_attrs(graph, edge_attr)

Arguments

graph

A graph object of class dgr_graph.

edge_attr

The name of the edge attribute column to drop.

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(), edge_data(), join_edge_attrs(), mutate_edge_attrs(), mutate_edge_attrs_ws(), recode_edge_attrs(), rename_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 = 6,
    set_seed = 23) %>%
  set_edge_attrs(
    edge_attr = value,
    values = 3) %>%
  mutate_edge_attrs(
    penwidth = value * 2)

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

# Drop the `value` edge
# attribute
graph <-
  graph %>%
  drop_edge_attrs(
    edge_attr = value)

# Get the graph's internal
# edf to show that the edge
# attribute `value` had been
# removed
graph %>% get_edge_df()
#>   id from to  rel penwidth
#> 1  1    1  4 <NA>        6
#> 2  2    2  3 <NA>        6
#> 3  3    2  4 <NA>        6
#> 4  4    3  1 <NA>        6
#> 5  5    4  1 <NA>        6
#> 6  6    5  4 <NA>        6