1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/get_graph_actions.R
3\name{get_graph_actions}
4\alias{get_graph_actions}
5\title{Get information on any available graph actions}
6\usage{
7get_graph_actions(graph)
8}
9\arguments{
10\item{graph}{A graph object of class \code{dgr_graph}.}
11}
12\value{
13A \code{df_tbl} object.
14}
15\description{
16Get a tibble of the available graph actions, which contains information on
17function invocations to be called on the graph at every transformation step,
18or, when manually invoked with the \code{\link[=trigger_graph_actions]{trigger_graph_actions()}} function.
19}
20\examples{
21# Create a random graph using the
22# `add_gnm_graph()` function
23graph <-
24  create_graph(
25    directed = FALSE) \%>\%
26  add_gnm_graph(
27    n = 10,
28    m = 15,
29    set_seed = 23)
30
31# Add a graph action that sets a node
32# attr column with a function; the
33# main function `set_node_attr_w_fcn()`
34# uses the `get_betweenness()` function
35# to provide betweenness values in the
36# `btwns` column
37graph <-
38  graph \%>\%
39  add_graph_action(
40    fcn = "set_node_attr_w_fcn",
41    node_attr_fcn = "get_betweenness",
42    column_name = "btwns",
43    action_name = "get_btwns")
44
45# To ensure that the action is
46# available in the graph, use the
47# `get_graph_actions()` function
48graph \%>\% get_graph_actions()
49
50}
51