Description Usage Arguments Details Value Author(s) References Examples
Identify a causal query
from available data
in a causal model described by a graph
that is a semi-Markovian DAG or a labeled directed acyclic graph (LDAG). For DAGs, special mechanisms related to transportability of causal effects, recoverability from selection bias and identifiability under missing data can also be included.
1 2 3 |
data |
a character string describing the available distributions in the package syntax. Alternatively, a list of character vectors. See ‘Details’. |
query |
a character string describing the target distribution in the package syntax. Alternatively, a character vector. See ‘Details’. |
graph |
a character string describing either a DAG or an LDAG in the package syntax. Alternatively, an "igraph" graph as used in the "causaleffect" package or a DAG constructed using the "dagitty" package. See ‘Details’. |
transportability |
a character string describing the transportability nodes of the model in the package syntax (for DAGs only). See ‘Details’. |
selection_bias |
a character string describing the selection bias nodes of the model in the package syntax (for DAGs only). See ‘Details’. |
missing_data |
a character string describing the missing data mechanisms of the model in the package syntax (for DAGs only). See ‘Details’. |
control |
a list of control parameters. See ‘Details’. |
data
is used to list the available input distributions. When graph
is a DAG the distributions should be of the form
P(Ai|do(Bi),Ci)
Individual variables within sets should be separated by a comma. For example, three input distributions
P(Z|do(X)), P(W,Y|do(Z,X)), P(W,Y,X|Z)
should be given as follows:
1 2 3 4 5 | > data <- "
+ P(Z|do(X))
+ P(W,Y|do(Z,X))
+ P(W,Y,X|Z)
+"
|
The use of multiple do-operators is not permitted. Furthermore, when both conditioning variables and a do-operator are present, every conditioning variable must either precede the do-operator or follow it. When graph
is an LDAG, the do-operation is represented by an intervention node, i.e.,
P(Y|do(X),Z) = P(Y|X,Z,I_X = 1)
For example, in the case of the previous example in an LDAG, the three input distributions become:
1 2 3 4 5 | > data <- "
+ P(Z|X,I_X = 1)
+ P(W,Y|Z,X,I_X=1,I_Z=1)
+ P(W,Y,X|Z)
+"
|
The intervention nodes I_X and I_Z must be explicitly defined in the graph
along with the relevant labels for the edges.
query
is the target distribution of the search. It has the same syntax as data
, but only a single distribution should be given.
graph
is a description of a directed acyclic graph where directed edges are denoted by ->
and bidirected arcs corresponding to unobserved confounders are denoted by <->
(or by --
). As an example, a DAG with two directed edges and one bidirected edge is constructed as follows:
1 2 3 4 5 | > graph <- "
+ X -> Z
+ Z -> Y
+ X <-> Y
+"
|
Some alternative formats for DAGs are supported as well. Graphs created using the igraph
package in the causal.effect
syntax can be used here. Similarly, DAGs created using dagitty
are supported.
LDAGs are constructed similarly with the addition of labels and with the omission bidirected edges (latent variables must be explicitly defined). As an example, an LDAG with two labeled edges can be constructed as follows:
1 2 3 4 5 6 | > graph <- "
+ X -> Z : A = 0
+ Z -> Y : A = 1
+ A -> Z
+ A -> Y
+"
|
Here the labels indicate that the edge from X to Z vanishes when A has the value 0 and the edge from Z to Y vanishes when A has the value 1. Multiple labels on the same edge should be separated by a semi-colon.
transportability
enumerates the nodes that should be understood as transportability nodes responsible for discrepancies between domains. Individual variables should be separated by a comma. See e.g., Bareinboim and Pearl (2014) for details on transportability.
selection_bias
enumerates the nodes that should be understood as selection bias nodes responsible for bias in the input data sets. Individual variables should be separated by a comma. See e.g., Bareinboim and Pearl (2014) for details on selection bias recoverability.
missing_data
enumerates the missingness mechanisms of the model. The syntax for a single mechanism is M_X : X
where MX is the mechanism for X. Individual mechanisms should be separated by a comma. Note that both MX and X must be present in the graph if the corresponding mechanism is given as input. Proxy variables should not be included in the graph, since they are automatically generated based on missing_data
. By default, a warning is issued if a proxy variable is present in an input distribution but its corresponding mechanism is not present in any input. See e.g., Mohan, Pearl and Tian (2013) for details on missing data as a causal inference problem.
The control
argument is a list that can supply any of the following components:
benchmark
A logical value. If TRUE
, the search time is recorded and returned (in milliseconds). Defaults to FALSE
.
benchmark_rules
A logical value. If TRUE
, the time taken by each individual inference rule is also recorded in the benchmark (in milliseconds). Defaults to FALSE
.
draw_derivation
A logical value. If TRUE
, a string representing the derivation steps as a DOT graph is returned. The graph can be exported as an image for example by using the DOT
package. Defaults to FALSE
.
draw_all
A logical value. If TRUE
and if draw_derivation = TRUE
, the derivation will contain every step taken by the search. If FALSE
, only steps that resulted in an identifiable target are returned. Defaults to FALSE
.
formula
A logical value. If TRUE
, a string representing the identifiable query is returned when the target query is identifiable. If FALSE
, only a logical value is returned that takes the value TRUE
for an identifiable target and FALSE
otherwise. Defaults to TRUE
.
heuristic
A logical value. If TRUE
, new distributions are expanded according to a search heuristic (see Tikka et al. (2019) for details). Otherwise, distributions are expanded in the order in which they were identified. Defaults to FALSE
.
md_sym
A single character describing the symbol to use for active missing data mechanisms. Defaults to "1"
.
time_limit
A numeric value giving a time limit for the search (in hours). Defaults to a negative value that disables the limit.
verbose
A logical value. If TRUE
, diagnostic information is printed to the console during the search. Defaults to FALSE
.
warn
A logical value. If TRUE
, a warning is issued for possibly unintentionally misspecified but syntactically correct input distributions.
An object of class dosearch
which is a list with the following components by default. See the options of control
for how to obtain a graphical representation of the derivation or how to benchmark the search.
identifiable
A logical value that attains the value TRUE
is the target quantity is identifiable and FALSE
otherwise.
formula
A character string describing a formula for an identifiable query or an empty character vector for an unidentifiable effect.
Santtu Tikka
S. Tikka, A. Hyttinen and J. Karvanen. Causal effect identification from multiple incomplete data sources: a general search-based approach. Journal of Statistical Software, 99(5):1–40, 2021.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | ## Simple back-door formula
data1 <- "P(x,y,z)"
query1 <- "P(y|do(x))"
graph1 <- "
x -> y
z -> x
z -> y
"
dosearch(data1, query1, graph1)
## Simple front-door formula
data2 <- "P(x,y,z)"
query2 <- "P(y|do(x))"
graph2 <- "
x -> z
z -> y
x <-> y
"
dosearch(data2, query2, graph2)
## Graph input using 'igraph' in the 'causaleffect' syntax
if (requireNamespace("igraph", quietly = TRUE)) {
g_igraph <- igraph::graph.formula(x -+ z, z -+ y, x -+ y, y -+ x)
g_igraph <- igraph::set.edge.attribute(g_igraph, "description", 3:4, "U")
dosearch(data2, query2, g_igraph)
}
## Graph input with 'dagitty'
if (requireNamespace("dagitty", quietly = TRUE)) {
g_dagitty <- dagitty::dagitty("dag{x -> z -> y; x <-> y}")
dosearch(data2, query2, g_dagitty)
}
## Alternative distribution input style using lists and vectors:
## Each element of the list describes a single distribution
## Each element is a character vector that describes the role
## of each variable in the distribution as follows:
## For a variable V and a distribution P(A|do(B),C) we have
## V = 0, if V is in A
## V = 1, if V is in B
## V = 2, if V is in C
data_alt <- list(
c(x = 0, y = 0, z = 0) # = P(x,y,z)
)
query_alt <- c(x = 1, y = 0) # = P(y|do(x))
dosearch(data_alt, query_alt, graph2)
## Additional examples
## Not run:
## Multiple input distributions (both observational and interventional)
data3 <- "
p(z_2,x_2|do(x_1))
p(z_1|x_2,do(x_1,y))
p(x_1|w_1,do(x_2))
p(y|z_1,z_2,x_1,do(x_2))
p(w|y,x_1,do(x_2))
"
query3 <- "p(y,x_1|w,do(x_2))"
graph3 <- "
x_1 -> z_2
x_1 -> z_1
x_2 -> z_1
x_2 -> z_2
z_1 -> y
z_2 -> y
x_1 -> w
x_2 -> w
z_1 -> w
z_2 -> w
"
dosearch(data3, query3, graph3)
## Selection bias
data4 <- "
p(x,y,z_1,z_2|s)
p(z_1,z_2)
"
query4 <- "p(y|do(x))"
graph4 <- "
x -> z_1
z_1 -> z_2
x -> y
y -- z_2
z_2 -> s
"
dosearch(data4, query4, graph4, selection_bias = "s")
## Transportability
data5 <- "
p(x,y,z_1,z_2)
p(x,y,z_1|s_1,s_2,do(z_2))
p(x,y,z_2|s_3,do(z_1))
"
query5 <- "p(y|do(x))"
graph5 <- "
z_1 -> x
x -> z_2
z_2 -> y
z_1 <-> x
z_1 <-> z_2
z_1 <-> y
t_1 -> z_1
t_2 -> z_2
t_3 -> y
"
dosearch(data5, query5, graph5, transportability = "t_1, t_2, t_3")
## Missing data
## Proxy variables are denoted by an asterisk (*)
data6 <- "
p(x*,y*,z*,m_x,m_y,m_z)
"
query6 <- "p(x,y,z)"
graph6 <- "
z -> x
x -> y
x -> m_z
y -> m_z
y -> m_x
z <-> y
"
dosearch(data6, query6, graph6, missing_data = "m_x : x, m_y : y, m_z : z")
## An LDAG
data7 <- "P(X,Y,Z)"
query7 <- "P(Y|X,I_X=1)"
graph7 <- "
X -> Y : Z = 1
Z -> Y
Z -> X : I_X = 1
I_X -> X
H -> X : I_X = 1
H -> Z
Q -> Z
Q -> Y : Z = 0
"
dosearch(data7, query7, graph7)
## A more complicated LDAG
## with multiple assignments for the edge X -> Z
data8 <- "P(X,Y,Z,A,W)"
query8 <- "P(Y|X,I_X=1)"
graph8 <- "
I_X -> X
I_Z -> Z
A -> W
Z -> Y
A -> Z
X -> Z : I_Z = 1; A = 1
X -> Y : A = 0
W -> X : I_X = 1
W -> Y : A = 0
A -> Y
U -> X : I_X = 1
U -> Y : A = 1
"
dosearch(data8, query8, graph8)
## Export the DOT diagram of the derivation as an SVG file
## to the working directory via the DOT package.
## By default, only the identifying part is plotted.
## PostScript format is also supported.
if (requireNamespace("DOT", quietly = TRUE)) {
d <- get_derivation(data1, query1, graph1,
control = list(draw_derivation = TRUE))
DOT::dot(d$derivation, "derivation.svg")
}
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.