Generate a graph object — qd

Provide simple syntax specifying paths between nodes to generate a graph object.

Usage

qd_dag(
  edgelist,
  node_labs = NULL,
  node_aes_opts = list(),
  edge_aes_opts = list(),
  format_special = TRUE,
  verbose = FALSE,
  check_dag = TRUE,
  theme = "base",
  ...
)

Arguments

edgelist: A vector of node-edge relationships.
node_labs: A named character vector containing label names. Defaults to NULL.
node_aes_opts: A list feeding aesthetic options for nodes to DiagrammeR::node_aes(). Defaults to empty list.
edge_aes_opts: A list feeding aesthetic options for edges to DiagrammeR::edge_aes(). Defaults to empty list.
format_special: Render numeric elements in an alphanumeric alpha_id as subcripts. Defaults to TRUE.
verbose: Indicate whether to print node and edge dataframes to the console. See Details below. Defaults to TRUE.
check_dag: Logical. Check whether the graph conforms to the rules of DAGs. Defaults to TRUE.
theme: Choose theme for plot output. Defaults to "base". Setting theme to NULL will use DiagrammeR's NULL attribute theme.
...: Pass optional conditioned argument to qd_themes().

Details

Leaving the verbose set to TRUE may be advisable to ensure labels and IDs have not been mismatched. By default, qd_dag() alphabetizes nodes included in edgelist and does the same for node_labs under a first assumption that labels will begin with the same letter as their corresponding alpha_id, which may not always be the case.

Examples

# Provide a list of edges, with nodes specified as letters or single words.
edges <- c("A -> { B C } <- L",
           "B -> C")

# make a DAG object and render the graph using the default theme
g.obj <- qd_dag(edges)
#> 
#> 
#> CHECKED: The diagram is a DAG. 
DiagrammeR::render_graph(g.obj)


# Pass labels and aesthetic options for nodes or edges
g.obj2 <- qd_dag(edges,
                 node_labs = c("A" = "Alcohol",
                               "B" = "BP",
                               "C" = "CVD",
                               "L" = "State"),
                 node_aes_opts = list(shape = "plaintext",
                                      fillcolor = "none",
                                      color = "black"),
                 edge_aes_opts = list(arrowsize = 0.5,
                                      color = "gray"),
                 theme = NULL)
#> 
#> 
#> CHECKED: The diagram is a DAG. 
DiagrammeR::render_graph(g.obj2)