Skip to contents

Adjust for variables and activate any biasing paths that result

Usage

control_for(.tdy_dag, var, as_factor = TRUE, activate_colliders = TRUE, ...)

adjust_for(.tdy_dag, var, as_factor = TRUE, activate_colliders = TRUE, ...)

ggdag_adjust(
  .tdy_dag,
  var = 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 = 10,
  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(),
  collider_lines = TRUE
)

Arguments

.tdy_dag

input graph, an object of class tidy_dagitty or dagitty

var

a character vector, the variable(s) to adjust for.

as_factor

logical. Should the adjusted column be a factor?

activate_colliders

logical. Include colliders activated by adjustment?

...

additional arguments passed to tidy_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.

collider_lines

logical. Should the plot show paths activated by adjusting for a collider?

Value

a tidy_dagitty with a adjusted column for adjusted variables, as well as any biasing paths that arise, or a ggplot

Examples

dag <- dagify(m ~ a + b, x ~ a, y ~ b)

control_for(dag, var = "m")
#> # A DAG with 5 nodes and 4 edges
#> #
#> # Paths opened by conditioning on a collider: a <-> b, a <-> b, a <-> b, a <-> b
#> #
#> # A tibble: 11 × 10
#>    name       x        y direction to      xend     yend circular collider_line
#>    <chr>  <dbl>    <dbl> <fct>     <chr>  <dbl>    <dbl> <lgl>    <lgl>        
#>  1 a     -0.115 -1.27    ->        m     -0.794  0.00515 FALSE    FALSE        
#>  2 a     -0.115 -1.27    ->        x      0.480 -2.39    FALSE    FALSE        
#>  3 b     -1.47   1.28    ->        m     -0.794  0.00515 FALSE    FALSE        
#>  4 b     -1.47   1.28    ->        y     -2.06   2.39    FALSE    FALSE        
#>  5 m     -0.794  0.00515 NA        NA    NA     NA       FALSE    FALSE        
#>  6 x      0.480 -2.39    NA        NA    NA     NA       FALSE    FALSE        
#>  7 y     -2.06   2.39    NA        NA    NA     NA       FALSE    FALSE        
#>  8 a     -0.115 -1.27    <->       b     -1.47   1.28    NA       TRUE         
#>  9 a     -0.115 -1.27    <->       b     -1.47   1.28    NA       TRUE         
#> 10 a     -0.115 -1.27    <->       b     -1.47   1.28    NA       TRUE         
#> 11 a     -0.115 -1.27    <->       b     -1.47   1.28    NA       TRUE         
#> # ℹ 1 more variable: adjusted <fct>
ggdag_adjust(dag, var = "m")