|
a |
|
b/README.Rmd |
|
|
1 |
--- |
|
|
2 |
output: |
|
|
3 |
rmarkdown::github_document |
|
|
4 |
bibliography: "inst/REFERENCES.bib" |
|
|
5 |
--- |
|
|
6 |
|
|
|
7 |
<!-- README.md is generated from README.Rmd. Please edit that file --> |
|
|
8 |
|
|
|
9 |
```{r, echo = FALSE} |
|
|
10 |
knitr::opts_chunk$set( |
|
|
11 |
collapse = TRUE, |
|
|
12 |
comment = "#>", |
|
|
13 |
fig.path = "README-" |
|
|
14 |
) |
|
|
15 |
``` |
|
|
16 |
|
|
|
17 |
# R/`biotmle` |
|
|
18 |
|
|
|
19 |
[](https://github.com/nhejazi/biotmle/actions) |
|
|
20 |
[](https://codecov.io/github/nhejazi/biotmle?branch=master) |
|
|
21 |
[](http://www.repostatus.org/#active) |
|
|
22 |
[](https://bioconductor.org/checkResults/release/bioc-LATEST/biotmle) |
|
|
23 |
[](https://bioconductor.org/packages/release/bioc/html/biotmle.html) |
|
|
24 |
[](https://bioconductor.org/packages/release/bioc/html/biotmle.html) |
|
|
25 |
[](http://opensource.org/licenses/MIT) |
|
|
26 |
[](https://zenodo.org/badge/latestdoi/65854775) |
|
|
27 |
[](http://joss.theoj.org/papers/02be843d9bab1b598187bfbb08ce3949) |
|
|
28 |
|
|
|
29 |
> Targeted Learning with Moderated Statistics for Biomarker Discovery |
|
|
30 |
|
|
|
31 |
__Authors:__ [Nima Hejazi](https://nimahejazi.org), [Mark van der |
|
|
32 |
Laan](https://vanderlaan-lab.org/about), and [Alan |
|
|
33 |
Hubbard](https://hubbard.berkeley.edu) |
|
|
34 |
|
|
|
35 |
--- |
|
|
36 |
|
|
|
37 |
## What's `biotmle`? |
|
|
38 |
|
|
|
39 |
The `biotmle` R package facilitates biomarker discovery through a generalization |
|
|
40 |
of the moderated t-statistic [@smyth2004linear] that extends the procedure to |
|
|
41 |
locally efficient estimators of asymptotically linear target parameters |
|
|
42 |
[@tsiatis2007semiparametric]. The set of methods implemented modify targeted |
|
|
43 |
maximum likelihood (TML) estimators of statistical (or causal) target parameters |
|
|
44 |
(e.g., average treatment effect) to apply variance moderation to the standard |
|
|
45 |
variance estimator based on the efficient influence function (EIF) of the target |
|
|
46 |
parameter [@vdl2011targeted; @vdl2018targeted]. By performing a moderated |
|
|
47 |
hypothesis test that pools the individual probe-specific EIF-based variance |
|
|
48 |
estimates, a robust variance estimator is constructed, which stabilizes the |
|
|
49 |
standard error estimates and improves the performance of such estimators both in |
|
|
50 |
smaller samples and in settings where the EIF is poorly estimated. The resultant |
|
|
51 |
procedure allows for the construction of conservative hypothesis tests that |
|
|
52 |
reduce the false discovery rate and/or the family-wise error rate |
|
|
53 |
[@hejazi2021generalization]. Improvements upon prior TML-based approaches to |
|
|
54 |
biomarker discovery (e.g., @bembom2009biomarker) include both the moderated |
|
|
55 |
variance estimator as well as the use of conservative reference distributions |
|
|
56 |
for the corresponding moderated test statistics (e.g., logistic distribution), |
|
|
57 |
inspired by tail bounds based on concentration |
|
|
58 |
inequalities [@rosenblum2009confidence]; the latter prove critical for obtaining |
|
|
59 |
robust inference when the finite-sample distribution of the estimator deviates |
|
|
60 |
from normality. |
|
|
61 |
|
|
|
62 |
--- |
|
|
63 |
|
|
|
64 |
## Installation |
|
|
65 |
|
|
|
66 |
For standard use, install from |
|
|
67 |
[Bioconductor](https://bioconductor.org/packages/biotmle) using |
|
|
68 |
[`BiocManager`](https://CRAN.R-project.org/package=BiocManager): |
|
|
69 |
|
|
|
70 |
```{r bioc-installation, eval = FALSE} |
|
|
71 |
if (!requireNamespace("BiocManager", quietly=TRUE)) { |
|
|
72 |
install.packages("BiocManager") |
|
|
73 |
} |
|
|
74 |
BiocManager::install("biotmle") |
|
|
75 |
``` |
|
|
76 |
|
|
|
77 |
To contribute, install the bleeding-edge _development version_ from GitHub via |
|
|
78 |
[`remotes`](https://CRAN.R-project.org/package=remotes): |
|
|
79 |
|
|
|
80 |
```{r gh-master-installation, eval = FALSE} |
|
|
81 |
remotes::install_github("nhejazi/biotmle") |
|
|
82 |
``` |
|
|
83 |
|
|
|
84 |
Current and prior [Bioconductor](https://bioconductor.org) releases are |
|
|
85 |
available under branches with numbers prefixed by "RELEASE_". For example, to |
|
|
86 |
install the version of this package available via Bioconductor 3.6, use |
|
|
87 |
|
|
|
88 |
```{r gh-develop-installation, eval = FALSE} |
|
|
89 |
remotes::install_github("nhejazi/biotmle", ref = "RELEASE_3_6") |
|
|
90 |
``` |
|
|
91 |
|
|
|
92 |
--- |
|
|
93 |
|
|
|
94 |
## Example |
|
|
95 |
|
|
|
96 |
For details on how to best use the `biotmle` R package, please consult the most |
|
|
97 |
recent [package |
|
|
98 |
vignette](https://bioconductor.org/packages/release/bioc/vignettes/biotmle/inst/doc/exposureBiomarkers.html) |
|
|
99 |
available through the [Bioconductor |
|
|
100 |
project](https://bioconductor.org/packages/biotmle). |
|
|
101 |
|
|
|
102 |
--- |
|
|
103 |
|
|
|
104 |
## Issues |
|
|
105 |
|
|
|
106 |
If you encounter any bugs or have any specific feature requests, please [file an |
|
|
107 |
issue](https://github.com/nhejazi/biotmle/issues). |
|
|
108 |
|
|
|
109 |
--- |
|
|
110 |
|
|
|
111 |
## Contributions |
|
|
112 |
|
|
|
113 |
Contributions are very welcome. Interested contributors should consult our |
|
|
114 |
[contribution |
|
|
115 |
guidelines](https://github.com/nhejazi/biotmle/blob/master/CONTRIBUTING.md) |
|
|
116 |
prior to submitting a pull request. |
|
|
117 |
|
|
|
118 |
--- |
|
|
119 |
|
|
|
120 |
## Citation |
|
|
121 |
|
|
|
122 |
After using the `biotmle` R package, please cite both of the following: |
|
|
123 |
|
|
|
124 |
@article{hejazi2017biotmle, |
|
|
125 |
author = {Hejazi, Nima S and Cai, Weixin and Hubbard, Alan E}, |
|
|
126 |
title = {biotmle: Targeted Learning for Biomarker Discovery}, |
|
|
127 |
journal = {The Journal of Open Source Software}, |
|
|
128 |
volume = {2}, |
|
|
129 |
number = {15}, |
|
|
130 |
month = {July}, |
|
|
131 |
year = {2017}, |
|
|
132 |
publisher = {The Open Journal}, |
|
|
133 |
doi = {10.21105/joss.00295}, |
|
|
134 |
url = {https://doi.org/10.21105/joss.00295} |
|
|
135 |
} |
|
|
136 |
|
|
|
137 |
@article{hejazi2021generalization, |
|
|
138 |
author = {Hejazi, Nima S and Boileau, Philippe and {van der Laan}, |
|
|
139 |
Mark J and Hubbard, Alan E}, |
|
|
140 |
title = {A generalization of moderated statistics to data adaptive |
|
|
141 |
semiparametric estimation in high-dimensional biology}, |
|
|
142 |
journal={under review}, |
|
|
143 |
volume={}, |
|
|
144 |
number={}, |
|
|
145 |
pages={}, |
|
|
146 |
year = {2021+}, |
|
|
147 |
publisher={}, |
|
|
148 |
doi = {}, |
|
|
149 |
url = {https://arxiv.org/abs/1710.05451} |
|
|
150 |
} |
|
|
151 |
|
|
|
152 |
@manual{hejazi2019biotmlebioc, |
|
|
153 |
author = {Hejazi, Nima S and {van der Laan}, Mark J and Hubbard, Alan |
|
|
154 |
E}, |
|
|
155 |
title = {{biotmle}: {Targeted Learning} with moderated statistics for |
|
|
156 |
biomarker discovery}, |
|
|
157 |
doi = {10.18129/B9.bioc.biotmle}, |
|
|
158 |
url = {https://bioconductor.org/packages/biotmle}, |
|
|
159 |
note = {R package version 1.10.0} |
|
|
160 |
} |
|
|
161 |
|
|
|
162 |
--- |
|
|
163 |
|
|
|
164 |
## Related |
|
|
165 |
|
|
|
166 |
* [R/`biotmleData`](https://github.com/nhejazi/biotmleData) - R package with |
|
|
167 |
example experimental data for use with this analysis package. |
|
|
168 |
|
|
|
169 |
--- |
|
|
170 |
|
|
|
171 |
## Funding |
|
|
172 |
|
|
|
173 |
The development of this software was supported in part through grants from the |
|
|
174 |
National Institutes of Health: [P42 ES004705-29](https://projectreporter.nih.gov/project_info_details.cfm?aid=9260357&map=y) and [R01 ES021369-05](https://projectreporter.nih.gov/project_info_description.cfm?aid=9210551&icde=37849782&ddparam=&ddvalue=&ddsub=&cr=1&csb=default&cs=ASC&pball=). |
|
|
175 |
|
|
|
176 |
--- |
|
|
177 |
|
|
|
178 |
## License |
|
|
179 |
|
|
|
180 |
© 2016-2021 [Nima S. Hejazi](https://nimahejazi.org) |
|
|
181 |
|
|
|
182 |
The contents of this repository are distributed under the MIT license. See file |
|
|
183 |
`LICENSE` for details. |
|
|
184 |
|
|
|
185 |
--- |
|
|
186 |
|
|
|
187 |
## References |
|
|
188 |
|