ggdag: canonicalize – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

canonicalize

Canonicalize a DAG

Description

Takes an input graph with bidirected edges and replaces every bidirected edge x <-> y with a substructure x <- L -> y, where L is a latent variable. See dagitty::canonicalize() for details. Undirected edges are not currently supported in ggdag.

Usage

node_canonical(.dag, ...)

ggdag_canonical(
  .tdy_dag,
  ...,
  edge_type = "link_arc",
  node_size = 16,
  text_size = 3.88,
  label_size = text_size,
  text_col = "white",
  label_col = text_col,
  node = TRUE,
  stylized = FALSE,
  text = TRUE,
  use_labels = NULL
)

Arguments

`.dag, .tdy_dag`	input graph, an object of class `tidy_dagitty` or `dagitty`
`...`	additional arguments passed to `tidy_dagitty()`
`edge_type`	a character vector, the edge geom to use. One of: "link_arc", which accounts for directed and bidirected edges, "link", "arc", or "diagonal"
`node_size`	size of DAG node
`text_size`	size of DAG text
`label_size`	size of label text
`text_col`	color of DAG text
`label_col`	color of label text
`node`	logical. Should nodes be included in the DAG?
`stylized`	logical. Should DAG nodes be stylized? If so, use `geom_dag_nodes` and if not use `geom_dag_point`
`text`	logical. Should text be included in the DAG?
`use_labels`	a string. Variable to use for `geom_dag_repel_label()`. Default is `NULL`.

Value

a tidy_dagitty that includes L or a ggplot

Examples

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

ggdag(dag)

node_canonical(dag)
ggdag_canonical(dag)

ggdag

Analyze and Create Elegant Directed Acyclic Graphs

v0.2.3

MIT + file LICENSE

Authors

Malcolm Barrett [aut, cre] (<https://orcid.org/0000-0003-0299-5825>)

Initial release