DiagrammeR (version 0.8.4)

add_prism: Add a prism of nodes to the graph

Description

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

Usage

add_prism(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 describing the shape of the prism. For example, the triangonal prism has n equal to 3 and it is composed of 6 nodes and 9 edges. For any n-gonal prism, the graph will be generated with 2n nodes and 3n edges.

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 prism.

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.

Value

a graph object of class dgr_graph.

Examples

library(magrittr)

# Create a new graph and add a prism
graph <-
  create_graph() %>%
  add_prism(3, "prism")

# Get node information from this graph
node_info(graph)
#>   node label  type deg indeg outdeg loops
#> 1    1     1 prism   3     1      2     0
#> 2    2     2 prism   3     1      2     0
#> 3    3     3 prism   3     1      2     0
#> 4    4     4 prism   3     2      1     0
#> 5    5     5 prism   3     2      1     0
#> 6    6     6 prism   3     2      1     0