-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME.Rmd
305 lines (243 loc) · 11.4 KB
/
README.Rmd
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
---
output:
rmarkdown::github_document
bibliography: "inst/REFERENCES.bib"
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# R/`txshift`
<!-- badges: start -->
[](https://github.com/nhejazi/txshift/actions)
[](https://codecov.io/github/nhejazi/txshift?branch=master)
[](https://www.r-pkg.org/pkg/txshift)
[](https://CRAN.R-project.org/package=txshift)
[](https://CRAN.R-project.org/package=txshift)
[](https://www.repostatus.org/#active)
[](https://opensource.org/licenses/MIT)
[](https://doi.org/10.5281/zenodo.4070042)
[](https://doi.org/10.21105/joss.02447)
<!-- badges: end -->
> Efficient Estimation of the Causal Effects of Stochastic Interventions
__Authors:__ [Nima Hejazi](https://nimahejazi.org) and [David
Benkeser](https://www.sph.emory.edu/faculty/profile/#!dbenkes)
---
## What's `txshift`?
The `txshift` R package is designed to provide facilities for the construction
of efficient estimators of the counterfactual mean of an outcome under
stochastic interventions that depend on the natural value of treatment
[@diaz2012population; @haneuse2013estimation]. `txshift `implements and builds
upon a simplified algorithm for the targeted maximum likelihood (TML) estimator
of such a causal parameter, originally proposed by @diaz2018stochastic, and
makes use of analogous machinery to compute an efficient one-step estimator
[@pfanzagl1985contributions]. `txshift` integrates with the [`sl3`
package](https://github.com/tlverse/sl3) [@coyle-sl3-rpkg] to allow for ensemble
machine learning to be leveraged in the estimation procedure.
For many practical applications (e.g., vaccine efficacy trials), observed data
is often subject to a two-phase sampling mechanism (i.e., through the use of a
two-stage design). In such cases, efficient estimators (of both varieties) must
be augmented to construct unbiased estimates of the population-level causal
parameter. @rose2011targeted2sd first introduced an augmentation procedure that
relies on introducing inverse probability of censoring (IPC) weights directly to
an appropriate loss function or to the efficient influence function estimating
equation. `txshift` extends this approach to compute IPC-weighted one-step and
TML estimators of the counterfactual mean outcome under a shift stochastic
treatment regime. The package is designed to implement the statistical
methodology described in @hejazi2020efficient and extensions thereof.
---
## Installation
For standard use, we recommend installing the package from
[CRAN](https://CRAN.R-project.org/package=txshift) via
```{r cran-installation, eval = FALSE}
install.packages("txshift")
```
_Note:_ If `txshift` is installed from
[CRAN](https://CRAN.R-project.org/package=txshift), the `sl3`, an enhancing
dependency that allows ensemble machine learning to be used for nuisance
parameter estimation, won't be included. We highly recommend additionally
installing `sl3` from GitHub via
[`remotes`](https://CRAN.R-project.org/package=remotes):
```{r sl3-gh-master-installation, eval = FALSE}
remotes::install_github("tlverse/sl3@master")
```
For the latest features, install the most recent _stable version_ of `txshift`
from GitHub via [`remotes`](https://CRAN.R-project.org/package=remotes):
```{r gh-master-installation, eval = FALSE}
remotes::install_github("nhejazi/txshift@master")
```
To contribute, install the _development version_ of `txshift` from GitHub via
[`remotes`](https://CRAN.R-project.org/package=remotes):
```{r gh-devel-installation, eval = FALSE}
remotes::install_github("nhejazi/txshift@devel")
```
---
## Example
To illustrate how `txshift` may be used to ascertain the effect of a treatment,
consider the following example:
```{r example, warning=FALSE}
library(txshift)
library(sl3)
set.seed(429153)
# simulate simple data
n_obs <- 500
W <- replicate(2, rbinom(n_obs, 1, 0.5))
A <- rnorm(n_obs, mean = 2 * W, sd = 1)
Y <- rbinom(n_obs, 1, plogis(A + W + rnorm(n_obs, mean = 0, sd = 1)))
# now, let's introduce a a two-stage sampling process
C_samp <- rbinom(n_obs, 1, plogis(W + Y))
# fit the full-data TMLE (ignoring two-phase sampling)
tmle <- txshift(
W = W, A = A, Y = Y, delta = 0.5,
estimator = "tmle",
g_exp_fit_args = list(
fit_type = "sl",
sl_learners_density = Lrnr_density_hse$new(Lrnr_hal9001$new())
),
Q_fit_args = list(fit_type = "glm", glm_formula = "Y ~ .")
)
tmle
# fit a full-data one-step estimator for comparison (again, no sampling)
os <- txshift(
W = W, A = A, Y = Y, delta = 0.5,
estimator = "onestep",
g_exp_fit_args = list(
fit_type = "sl",
sl_learners_density = Lrnr_density_hse$new(Lrnr_hal9001$new())
),
Q_fit_args = list(fit_type = "glm", glm_formula = "Y ~ .")
)
os
# fit an IPCW-TMLE to account for the two-phase sampling process
tmle_ipcw <- txshift(
W = W, A = A, Y = Y, delta = 0.5, C_samp = C_samp, V = c("W", "Y"),
estimator = "tmle", max_iter = 5, eif_reg_type = "glm",
samp_fit_args = list(fit_type = "glm"),
g_exp_fit_args = list(
fit_type = "sl",
sl_learners_density = Lrnr_density_hse$new(Lrnr_hal9001$new())
),
Q_fit_args = list(fit_type = "glm", glm_formula = "Y ~ .")
)
tmle_ipcw
# compare with an IPCW-agumented one-step estimator under two-phase sampling
os_ipcw <- txshift(
W = W, A = A, Y = Y, delta = 0.5, C_samp = C_samp, V = c("W", "Y"),
estimator = "onestep", eif_reg_type = "glm",
samp_fit_args = list(fit_type = "glm"),
g_exp_fit_args = list(
fit_type = "sl",
sl_learners_density = Lrnr_density_hse$new(Lrnr_hal9001$new())
),
Q_fit_args = list(fit_type = "glm", glm_formula = "Y ~ .")
)
os_ipcw
```
---
## Issues
If you encounter any bugs or have any specific feature requests, please [file an
issue](https://github.com/nhejazi/txshift/issues). Further details on filing
issues are provided in our [contribution
guidelines](https://github.com/nhejazi/txshift/blob/master/CONTRIBUTING.md).
---
## Contributions
Contributions are very welcome. Interested contributors should consult our
[contribution
guidelines](https://github.com/nhejazi/txshift/blob/master/CONTRIBUTING.md)
prior to submitting a pull request.
---
## Citation
After using the `txshift` R package, please cite the following:
@article{hejazi2020efficient,
author = {Hejazi, Nima S and {van der Laan}, Mark J and Janes, Holly
E and Gilbert, Peter B and Benkeser, David C},
title = {Efficient nonparametric inference on the effects of
stochastic interventions under two-phase sampling, with
applications to vaccine efficacy trials},
year = {2021},
doi = {10.1111/biom.13375},
url = {https://doi.org/10.1111/biom.13375},
journal = {Biometrics},
publisher = {Wiley Online Library}
}
@article{hejazi2020txshift-joss,
author = {Hejazi, Nima S and Benkeser, David C},
title = {{txshift}: Efficient estimation of the causal effects of
stochastic interventions in {R}},
year = {2020},
doi = {10.21105/joss.02447},
url = {https://doi.org/10.21105/joss.02447},
journal = {Journal of Open Source Software},
publisher = {The Open Journal}
}
@software{hejazi2022txshift-rpkg,
author = {Hejazi, Nima S and Benkeser, David C},
title = {{txshift}: Efficient Estimation of the Causal Effects of
Stochastic Interventions},
year = {2022},
doi = {10.5281/zenodo.4070042},
url = {https://CRAN.R-project.org/package=txshift},
note = {R package version 0.3.9}
}
---
## Related
* [R/`tmle3shift`](https://github.com/tlverse/tmle3shift) - An R package that
is an independent implementation of the same core methodology for TML
estimation as provided here but written based on the
[`tmle3`](https://github.com/tlverse/tmle3) engine of the [`tlverse`
ecosystem](https://github.com/tlverse). Unlike `txshift`, this package does
not provide tools for estimation under two-phase sampling designs.
* [R/`medshift`](https://github.com/nhejazi/medshift) - An experimental R
package for estimating causal mediation effects with stochastic interventions,
including via inverse probability weighted and asymptotically efficient
one-step estimators, as first described in @diaz2020causal.
* [R/`haldensify`](https://github.com/nhejazi/haldensify) - An R package for
estimating the generalized propensity score (conditional density) nuisance
parameter using the [highly adaptive
lasso](https://github.com/tlverse/hal9001) [@coyle-hal9001-rpkg;
@hejazi2020hal9001-joss] via an application of pooled hazard regression
[@diaz2011super].
* [R/`lmtp`](https://github.com/nt-williams/lmtp) - An R package for estimating
the causal effects of *longitudinal* modified treatment policies, which are a
generalization of the type of effect considered in this package. The LMTP
framework was first introduced in @diaz2021nonparametric and the `lmtp`
package is described in @williams2023lmtp.
---
## Funding
The development of this software was supported in part through grants from the
National Library of Medicine (award no. [T32
LM012417](https://reporter.nih.gov/project-details/9248418)), the National
Institute of Allergy and Infectious Diseases (award no. [R01
AI074345](https://reporter.nih.gov/project-details/9926564)), and the National
Science Foundation (award no. [DMS
2102840](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2102840)).
---
## License
© 2017-2024 [Nima S. Hejazi](https://nimahejazi.org)
The contents of this repository are distributed under the MIT license. See below
for details:
```
MIT License
Copyright (c) 2017-2024 Nima S. Hejazi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
---
## References