Generating Equivalent Models — Equivalent DAGs and Classes • ggdag

Returns a set of complete partially directed acyclic graphs (CPDAGs) given an input DAG. CPDAGs are Markov equivalent to the input graph. See dagitty::equivalentDAGs() for details. node_equivalent_dags() returns a set of DAGs, while node_equivalent_class() tags reversable edges. ggdag_equivalent_dags() plots all equivalent DAGs, while ggdag_equivalent_class() plots all reversable edges as undirected.

Usage

node_equivalent_dags(.dag, n = 100, layout = "auto", ...)

ggdag_equivalent_dags(
  .tdy_dag,
  ...,
  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,
  text = NULL,
  label = NULL,
  node = deprecated(),
  stylized = deprecated()
)

node_equivalent_class(.dag, layout = "auto")

ggdag_equivalent_class(
  .tdy_dag,
  ...,
  size = 1,
  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,
  text = NULL,
  label = NULL,
  node = deprecated(),
  stylized = deprecated()
)

Arguments

.dag: input graph, an object of class tidy_dagitty or dagitty
n: maximal number of returned graphs.
layout: a layout available in ggraph. See ggraph::create_layout() for details. Alternatively, "time_ordered" will use time_ordered_coords() to algorithmically sort the graph by time.
...: optional arguments passed to ggraph::create_layout()
.tdy_dag: an object of class tidy_dagitty or dagitty
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()?
text: The bare name of a column to use for geom_dag_text(). If use_text = TRUE, the default is to use name.
label: The bare name of a column to use for geom_dag_label_repel(). If use_labels = TRUE, the default is to use label.
node: Deprecated.
stylized: Deprecated.

Value

a tidy_dagitty with at least one DAG, including a dag column to identify graph set for equivalent DAGs or a reversable column for equivalent classes, or a ggplot

Examples

g_ex <- dagify(y ~ x + z, x ~ z)

g_ex %>% node_equivalent_class()
#> # A DAG with 3 nodes and 3 edges
#> #
#> # A tibble: 4 × 9
#>   name      x     y direction to     xend  yend circular reversable
#>   <chr> <dbl> <dbl> <fct>     <chr> <dbl> <dbl> <lgl>    <lgl>     
#> 1 x       0       2 ->        y       0.5     1 FALSE    TRUE      
#> 2 y       0.5     1 NA        NA     NA      NA FALSE    FALSE     
#> 3 z       0.5     3 ->        x       0       2 FALSE    TRUE      
#> 4 z       0.5     3 ->        y       0.5     1 FALSE    TRUE      

g_ex %>% ggdag_equivalent_dags()