DiagrammeR (version 0.9.2)

get_agg_degree_out: Get an aggregate value from the outdegree of nodes

Description

Get a single, aggregate value from the outdegree values for all nodes in a graph, or, a subset of graph nodes.

Usage

get_agg_degree_out(graph, agg, conditions = NULL)

Arguments

graph

a graph object of class dgr_graph.

agg

the aggregation function to use for summarizing outdegree values from graph nodes. The following aggregation functions can be used: sum, min, max, mean, or median.

conditions

an option to use filtering conditions for the nodes to consider.

Value

a vector with an aggregate outdegree value.

Examples

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

# Get the mean outdegree value from all
# nodes in the graph
get_agg_degree_out(
  graph = random_graph,
  agg = "mean")
#> [1] 3.666667

# Other aggregation functions can be used
# (`min`, `max`, `median`, `sum`); let's
# get the median in this example
get_agg_degree_out(
  graph = random_graph,
  agg = "median")
#> [1] 3

# The aggregation of outdegree can occur
# for a subset of the graph nodes and this
# is made possible by specifying `conditions`
# for the nodes
get_agg_degree_out(
  graph = random_graph,
  agg = "mean",
  conditions = value < 5.0)
#> [1] 3.666667
# }