Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
247 lines (221 sloc) 7.43 KB
#' Quickly create a DAGs with common structures of bias
#'
#' base functions create an object of class `dagitty`; `ggdag_* ` functions
#' are wrappers that also call `ggdag()` on the `dagitty` object.
#'
#' @param x,y,a,b,m,z Character vector. Optional label. Default is `NULL`
#' @param x_y_associated Logical. Are x and y associated? Default is `FALSE`.
#' @param 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"
#' @param node_size size of DAG node
#' @param text_size size of DAG text
#' @param label_size size of label text
#' @param text_col color of DAG text
#' @param label_col color of label text
#' @param node logical. Should nodes be included in the DAG?
#' @param stylized logical. Should DAG nodes be stylized? If so, use
#' `geom_dag_nodes` and if not use `geom_dag_point`
#' @param text logical. Should text be included in the DAG?
#' @param use_labels a string. Variable to use for `geom_dag_repel_label()`.
#' Default is `NULL`.
#'
#' @return a DAG of class `dagitty` or a `ggplot`
#' @export
#'
#' @examples
#' m_bias() %>% ggdag_adjust("m")
#' ggdag_confounder_triangle()
#'
#' @rdname quick_plot
#' @name Quick Plots for Common DAGs
m_bias <- function(x = NULL, y = NULL, a = NULL, b = NULL, m = NULL, x_y_associated = FALSE) {
coords <- tibble::tribble(
~name, ~x, ~y,
"x", 0, 0,
"y", 2, 0,
"a", 0, 1,
"b", 2, 1,
"m", 1, .5
)
if (x_y_associated) {
.dag <- dagify(
m ~ a + b,
x ~ a,
y ~ b + x,
exposure = "x",
outcome = "y",
coords = coords)
} else {
.dag <- dagify(
m ~ a + b,
x ~ a,
y ~ b,
exposure = "x",
outcome = "y",
coords = coords)
}
if (!is.null(c(x, y, a, b, m))) label(.dag) <- c(x = x, y = y, a = a, b = b, m = m)
.dag
}
#' @rdname quick_plot
#' @export
butterfly_bias <- function(x = NULL, y = NULL, a = NULL, b = NULL, m = NULL, x_y_associated = FALSE) {
coords <- tibble::tribble(
~name, ~x, ~y,
"x", 0, 0,
"y", 2, 0,
"a", 0, 1,
"b", 2, 1,
"m", 1, .5
)
if (x_y_associated) {
.dag <- dagify(
m ~ a + b,
x ~ a + m,
y ~ b + x + m,
exposure = "x",
outcome = "y",
coords = coords)
} else {
.dag <- dagify(
m ~ a + b,
x ~ a + m,
y ~ b + m,
exposure = "x",
outcome = "y",
coords = coords)
}
if (!is.null(c(x, y, a, b, m))) label(.dag) <- c(x = x, y = y, a = a, b = b, m = m)
.dag
}
#' @rdname quick_plot
#' @export
confounder_triangle <- function(x = NULL, y = NULL, z = NULL, x_y_associated = FALSE) {
coords <- tibble::tribble(
~name, ~x, ~y,
"x", 0, 0,
"y", 2, 0,
"z", 1, 1
)
if (x_y_associated) {
.dag <- dagify(
x ~ z,
y ~ x + z,
exposure = "x",
outcome = "y",
coords = coords)
} else {
.dag <- dagify(
x ~ z,
y ~ z,
exposure = "x",
outcome = "y",
coords = coords)
}
if (!is.null(c(x, y, z))) label(.dag) <- c(x = x, y = y, z = z)
.dag
}
#' @rdname quick_plot
#' @export
collider_triangle <- function(x = NULL, y = NULL, m = NULL, x_y_associated = FALSE) {
coords <- tibble::tribble(
~name, ~x, ~y,
"x", 0, 1,
"y", 2, 1,
"m", 1, 0
)
if (x_y_associated) {
.dag <- dagify(
m ~ x + y,
y ~ x,
exposure = "x",
outcome = "y",
coords = coords)
} else {
.dag <- dagify(
m ~ x + y,
exposure = "x",
outcome = "y",
coords = coords)
}
if (!is.null(c(x, y, m))) label(.dag) <- c(x = x, y = y, m = m)
.dag
}
#' @rdname quick_plot
#' @export
mediation_triangle <- function(x = NULL, y = NULL, m = NULL, x_y_associated = FALSE) {
coords <- tibble::tribble(
~name, ~x, ~y,
"x", 0, 0,
"y", 2, 0,
"m", 1, 1
)
if (x_y_associated) {
.dag <- dagify(
m ~ x,
y ~ x + m,
exposure = "x",
outcome = "y",
coords = coords)
} else {
.dag <- dagify(
m ~ x,
y ~ m,
exposure = "x",
outcome = "y",
coords = coords)
}
if (!is.null(c(x, y, m))) label(.dag) <- c(x = x, y = y, m = m)
.dag
}
#' @rdname quick_plot
#' @export
ggdag_m_bias <- function(x = NULL, y = NULL, a = NULL, b = NULL, m = NULL, x_y_associated = FALSE,
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) {
ggdag(m_bias(x, y, a, b, m, x_y_associated), edge_type = edge_type,
node_size = node_size, text_size = text_size, text_col = text_col, label_col = label_col,
node = node, stylized = stylized, text = text, use_labels = use_labels)
}
#' @rdname quick_plot
#' @export
ggdag_butterfly_bias <- function(x = NULL, y = NULL, a = NULL, b = NULL, m = NULL, x_y_associated = FALSE,
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) {
ggdag(butterfly_bias(x, y, a, b, m, x_y_associated), edge_type = edge_type,
node_size = node_size, text_size = text_size, text_col = text_col, label_col = label_col,
node = node, stylized = stylized, text = text, use_labels = use_labels)
}
#' @rdname quick_plot
#' @export
ggdag_confounder_triangle <- function(x = NULL, y = NULL, z = NULL, x_y_associated = FALSE,
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) {
ggdag(confounder_triangle(x, y, z, x_y_associated), edge_type = edge_type,
node_size = node_size, text_size = text_size, text_col = text_col, label_col = label_col,
node = node, stylized = stylized, text = text, use_labels = use_labels)
}
#' @rdname quick_plot
#' @export
ggdag_collider_triangle <- function(x = NULL, y = NULL, m = NULL, x_y_associated = FALSE,
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) {
ggdag(collider_triangle(x, y, m, x_y_associated), edge_type = edge_type,
node_size = node_size, text_size = text_size, text_col = text_col, label_col = label_col,
node = node, stylized = stylized, text = text, use_labels = use_labels)
}
#' @rdname quick_plot
#' @export
ggdag_mediation_triangle <- function(x = NULL, y = NULL, m = NULL, x_y_associated = FALSE,
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) {
ggdag(mediation_triangle(x, y, m, x_y_associated), edge_type = edge_type,
node_size = node_size, text_size = text_size, text_col = text_col, label_col = label_col,
node = node, stylized = stylized, text = text, use_labels = use_labels)
}