DiagrammeR (version 0.9.2)

add_graph_action: Add a graph action for execution at every transform

Description

Add a graph function along with its arguments to be run at every graph transformation step.

Usage

add_graph_action(graph, fcn, ..., action_name = NULL)

Arguments

graph

a graph object of class dgr_graph.

fcn

the name of the function to use.

...

arguments and values to pass to the named function in fcn, if necessary.

action_name

an optional name for labeling the action.

Value

a graph object of class dgr_graph.

Examples

# NOT RUN {
# Create a random graph
graph <-
  create_random_graph(
    n = 10, m = 22,
    set_seed = 23)

# Add a graph action that sets a node
# attr column with a function; the
# main function `set_node_attr_w_fcn()`
# uses the `get_betweenness()` function
# to provide betweenness values in the
# `btwns` column; this action will
# occur whenever there is a function
# called on the graph that modifies it
# (e.g., `add_n_nodes()`)
graph <-
  graph %>%
  add_graph_action(
    fcn = "set_node_attr_w_fcn",
    node_attr_fcn = "get_betweenness",
    column_name = "btwns",
    action_name = "get_btwns")

# To ensure that the action is
# available in the graph, use the
# `get_graph_actions()` function
graph %>%
  get_graph_actions()
#> # A tibble: 1 x 3
#>   action_index action_name
#>          <dbl>       <chr>
#> 1            1   get_btwns
#> # ... with 1 more variables:
#> #   expression <chr>
# }