View source: R/set_edge_attr_to_display.R
set_edge_attr_to_display | R Documentation |
Set a edge attribute type to display as edge text when calling the
render_graph()
function. This allows for display of different types of edge
attribute values on a per-edge basis. Without setting the display
attribute, rendering a graph will default to not printing any text on edges.
Setting the display
edge attribute with this function for the first time
(i.e., the display
column doesn't exist in the graph's internal edge data
frame) will insert the attr
value for all edges specified in edges
and a
default value (default
) for all remaining edges.
set_edge_attr_to_display(graph, attr = NULL, edges = NULL, default = "label")
graph |
A graph object of class |
attr |
The name of the attribute from which label text for the edge will
be obtained. If set to |
edges |
A length vector containing one or several edge ID values (as
integers) for which edge attributes are set for display in the rendered
graph. If |
default |
The name of an attribute to set for all other graph edges not
included in |
A graph object of class dgr_graph
.
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()
,
rename_edge_attrs()
,
rescale_edge_attrs()
,
rev_edge_dir()
,
rev_edge_dir_ws()
,
set_edge_attrs()
,
set_edge_attrs_ws()
# Create a random graph using the
# `add_gnm_graph()` function
graph <-
create_graph() %>%
add_gnm_graph(
n = 4,
m = 4,
set_seed = 23) %>%
set_edge_attrs(
edge_attr = value,
values = c(2.5, 8.2, 4.2, 2.4))
# For edge ID values of `1`,
# `2`, and `3`, choose to display
# the edge `value` attribute (for
# the other edges, display nothing)
graph <-
graph %>%
set_edge_attr_to_display(
edges = 1:3,
attr = value,
default = NA)
# Show the graph's edge data frame; the
# `display` edge attribute will show, for
# each row, which edge attribute value to
# display when the graph is rendered
graph %>% get_edge_df()
# This function can be called multiple
# times on a graph; after the first time
# (i.e., creation of the `display`
# attribute), the `default` value won't
# be used
graph %>%
set_edge_attr_to_display(
edges = 4,
attr = to) %>%
set_edge_attr_to_display(
edges = c(1, 3),
attr = id) %>%
get_edge_df()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.