get_constraint {DiagrammeR}R Documentation

Get constraint scores for one or more graph nodes

Description

Get the constraint scores (based on Burt's Constraint Index) for one or more nodes in a graph.

Usage

get_constraint(graph, nodes = NULL)

Arguments

graph

a graph object of class dgr_graph.

nodes

an optional vector of node IDs to consider for constraint scores. If not supplied, then constraint scores for all nodes in the graph will be calculated.

Value

a data frame with constraint scores for one or more graph nodes.

Examples

# Create a random graph
graph <-
  create_random_graph(
    10, 22, set_seed = 1)

# Get the constaint scores for all nodes in
# the graph
get_constraint(graph)
#>    node constraint
#> 1     1  0.3536111
#> 2     2  0.4172222
#> 3     3  0.4933333
#> 4     4  0.4528472
#> 5     5  0.3711188
#> 6     6  0.4583333
#> 7     7  0.3735494
#> 8     8  0.3072222
#> 9     9  0.4479167
#> 10   10  0.4447222

# Get the constaint scores for only nodes
# `5` and `7`
get_constraint(graph, c(5, 7))
#>    node constraint
#> 5     5  0.3711188
#> 7     7  0.3735494

[Package DiagrammeR version 0.8.4 Index]