ggdag: paths – R documentation

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

paths

Find Pathways Between Variables

Description

node_paths finds the pathways between a given exposure and outcome. ggdag_paths plots all pathways. See dagitty::paths() for details.

Usage

dag_paths(
  .dag,
  from = NULL,
  to = NULL,
  adjust_for = NULL,
  directed = FALSE,
  paths_only = FALSE,
  ...
)

ggdag_paths(
  .tdy_dag,
  from = NULL,
  to = NULL,
  adjust_for = NULL,
  directed = FALSE,
  shadow = FALSE,
  ...,
  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
)

ggdag_paths_fan(
  .tdy_dag,
  from = NULL,
  to = NULL,
  adjust_for = NULL,
  directed = FALSE,
  ...,
  shadow = FALSE,
  spread = 0.7,
  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`
`from`	character vector of length 1, name of exposure variable. Default is `NULL`, in which case it will check the input DAG for exposure.
`to`	character vector of length 1, name of exposure variable. Default is `NULL`, in which case it will check the input DAG for exposure.
`adjust_for`	character vector, a set of variables to control for. Default is `NULL`.
`directed`	logical. Should only directed paths be shown?
`paths_only`	logical. Should only open paths be returned? Default is `FALSE`, which includes every variable and edge in the DAG regardless if they are part of the path.
`...`	additional arguments passed to `tidy_dagitty()`
`shadow`	logical. Show edges not in path? Ignored if `paths_only` is `TRUE`
`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`	label color
`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`.
`spread`	the width of the fan spread

Value

a tidy_dagitty with a path column for path variables and a set grouping column or a ggplot

Examples

confounder_triangle(x_y_associated = TRUE) %>%
  ggdag_paths(from = "x", to = "y")

butterfly_bias(x_y_associated = TRUE) %>%
  ggdag_paths_fan(shadow = TRUE)

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