DiagrammeR (version 0.8.4)

add_star: Add a star of nodes to the graph

Description

With a graph object of class dgr_graph, add a node star to the graph.

Usage

add_star(graph, n, type = NULL, label = TRUE, rel = NULL, nodes = NULL)

Arguments

graph

a graph object of class dgr_graph that is created using create_graph.

n

the number of nodes comprising the star. The first node will be the center of the star.

type

an optional string that describes the entity type for the nodes to be added.

label

either a vector object of length n that provides optional labels for the new nodes, or, a boolean value where setting to TRUE ascribes node IDs to the label and FALSE yields a blank label.

rel

an optional string for providing a relationship label to all new edges created in the node star.

nodes

an optional vector of node IDs of length n for the newly created nodes. If nothing is provided, node IDs will assigned as monotonically increasing integers. The center node is considered the first node in this series.

Value

a graph object of class dgr_graph.

Examples

library(magrittr)

# Create a new graph and add 3 stars of varying
# numbers of nodes
graph <-
  create_graph() %>%
  add_star(4, "four_star") %>%
  add_star(5, "five_star") %>%
  add_star(6, "six_star")

# Get node information from this graph
node_info(graph)
#>    node label      type deg indeg outdeg loops
#> 1     1     1 four_star   3     0      3     0
#> 2     5     5 five_star   4     0      4     0
#> 3    10    10  six_star   5     0      5     0
#> 4     2     2 four_star   1     1      0     0
#> 5     3     3 four_star   1     1      0     0
#> 6     4     4 four_star   1     1      0     0
#> 7     6     6 five_star   1     1      0     0
#> 8     7     7 five_star   1     1      0     0
#> 9     8     8 five_star   1     1      0     0
#> 10    9     9 five_star   1     1      0     0
#> 11   11    11  six_star   1     1      0     0
#> 12   12    12  six_star   1     1      0     0
#> 13   13    13  six_star   1     1      0     0
#> 14   14    14  six_star   1     1      0     0
#> 15   15    15  six_star   1     1      0     0