geom_dag: Add common DAG layers to a ggplot

In malcolmbarrett/ggdag: Analyze and Create Elegant Directed Acyclic Graphs

Add common DAG layers to a ggplot

Description

geom_dag() is a helper function that adds common DAG layers to a ggplot. The purpose of geom_dag() is to simplify making custom DAGs. Most custom DAGs need the same basic layers, and so this function greatly reduces typing. It is not a true geom in that it adds many types of geoms to the plot (by default, edges, nodes, and text). While the underlying layers, all available in ggdag, are true geoms, we usually need a consistent set of layers to make a DAG. geom_dag() provides this. Because geom_dag() is not a true geom, you'll find that it is awkward for sophisticated customization. When you hit that point, you should use the underlying geoms directly.

Usage

geom_dag(
  data = NULL,
  size = 1,
  edge_type = c("link_arc", "link", "arc", "diagonal"),
  node_size = 16,
  text_size = 3.88,
  label_size = text_size,
  text_col = "white",
  label_col = "black",
  edge_width = 0.6,
  edge_cap = 8,
  arrow_length = 5,
  use_edges = TRUE,
  use_nodes = TRUE,
  use_stylized = FALSE,
  use_text = TRUE,
  use_labels = FALSE,
  label = NULL,
  text = NULL,
  node = deprecated(),
  stylized = deprecated()
)

Arguments

data	The data to be displayed in this layer. There are three options: If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot(). A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify() for which variables will be created. A function will be called with a single argument, the plot data. The return value must be a data.frame, and will be used as the layer data. A function can be created from a formula (e.g. ~ head(.x, 10)).
size	A numeric value scaling the size of all elements in the DAG. This allows you to change the scale of the DAG without changing the proportions.
edge_type	The type of edge, one of "link_arc", "link", "arc", "diagonal".
node_size	The size of the nodes.
text_size	The size of the text.
label_size	The size of the labels.
text_col	The color of the text.
label_col	The color of the labels.
edge_width	The width of the edges.
edge_cap	The size of edge caps (the distance between the arrowheads and the node borders).
arrow_length	The length of arrows on edges.
use_edges	A logical value. Include a ⁠geom_dag_edges*()⁠ function? If TRUE, which is determined by edge_type.
use_nodes	A logical value. Include geom_dag_point()?
use_stylized	A logical value. Include geom_dag_node()?
use_text	A logical value. Include geom_dag_text()?
use_labels	A logical value. Include geom_dag_label_repel()?
label	The bare name of a column to use for geom_dag_label_repel(). If use_labels = TRUE, the default is to use label.
text	The bare name of a column to use for geom_dag_text(). If use_text = TRUE, the default is to use name.
node	Deprecated.
stylized	Deprecated.

Value

A list of ggplot2 layer elements

Examples

# Basic usage with ggdag
library(ggplot2)
dag <- dagify(y ~ x, z ~ y)
ggplot(dag, aes_dag()) +
  geom_dag()
ggplot(dag, aes_dag()) +
  geom_dag(size = 1.5)
ggplot(dag, aes_dag()) +
  geom_dag(size = 1.5, text_size = 8)

malcolmbarrett/ggdag documentation built on March 8, 2024, 5:49 p.m.