DiagrammeR (version 0.9.0)

create_edge_df: Create an edge data frame

Description

Combine several named vectors for edges and their attributes into a data frame, which can be combined with other similarly-generated data frames, or, added to a graph object.

Usage

create_edge_df(from, to, rel = NULL, ...)

Arguments

from

a vector of node ID values from which edges are outbound. The vector length must equal that of the to vector.

to

a vector of node ID values to which edges are incoming. The vector length must equal that of the from vector.

rel

an optional rel label for each edge.

...

one or more named vectors for associated attributes.

Value

an edge data frame (edf).

Examples

# NOT RUN {
# Create a simple edge data frame (edf) and
# view the results
edf <-
  create_edge_df(
    from = c(1, 2, 3),
    to = c(4, 3, 1),
    rel = "a")

# Display the edge data frame
edf
#>   id from to rel
#> 1  1    1  4   a
#> 2  2    2  3   a
#> 3  3    3  1   a

# Create an edf with additional edge
# attributes (where their classes will be
# inferred from the input vectors)
edf <-
  create_edge_df(
    from = c(1, 2, 3),
    to = c(4, 3, 1),
    rel = "a",
    length = c(50, 100, 250),
    color = "green",
    width = c(1, 5, 2))

# Display the edge data frame
edf
#>   id from to rel length color width
#> 1  1    1  4   a     50 green     1
#> 2  2    2  3   a    100 green     5
#> 3  3    3  1   a    250 green     2
# }