forked from nhejazi/adaptest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
117 lines (85 loc) · 3.63 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
---
output: rmarkdown::github_document
bibliography: README-refs.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/`adaptest`
[](https://travis-ci.org/wilsoncai1992/adaptest?branch=master)
[](https://ci.appveyor.com/project/wilsoncai1992/adaptest/)
[](https://codecov.io/github/wilsoncai1992/adaptest?branch=master)
[](http://www.repostatus.org/#wip)
[](http://www.gnu.org/licenses/gpl-2.0.html)
[](http://joss.theoj.org/papers/7618d7d14ac77f6f502df3f9eac5917d)
> Data-adaptive statistics for multiple testing in high-dimensional problems
__Authors:__ Wilson Cai and [Nima Hejazi](http://nimahejazi.org)
---
## What's `adaptest`?
The `adaptest` R package is a tool for performing multiple testing on effect
sizes under high-dimensional settings, using the approach of data-adaptive
statistical target parameters and inference. For technical details on the
data-adaptive multiple testing procedure, consult @cai2018data. For an
introduction to statistical inference procedures using data-adaptive target
parameters, the interested reader is directed to @hubbard2016statistical.
---
## Installation
<!--
For standard use, install from [Bioconductor](https://bioconductor.org):
```{r bioc-installation, eval = FALSE}
source("https://bioconductor.org/biocLite.R")
biocLite("adaptest")
```
-->
Install the most recent _stable release_ from GitHub via
[`devtools`](https://www.rstudio.com/products/rpackages/devtools/):
```{r gh-master-installation, eval = FALSE}
devtools::install_github("wilsoncai1992/adaptest")
```
---
<!--
## Example
This is a basic example which shows you how to solve a common problem:
```{r example}
## basic example code
```
-->
## Issues
If you encounter any bugs or have any specific feature requests, please [file an
issue](https://github.com/wilsoncai1992/adaptest/issues).
---
## Contributions
It is our hope that `adaptest` will grow to be widely adopted as a tool for
employing data-adaptive multiple hypothesis testing procedures in
high-dimensional and complex problem settings. To that end, contributions are
very welcome, though we ask that interested contributors consult our
[`contribution
guidelines`](https://github.com/wilsoncai1992/adaptest/blob/master/CONTRIBUTING.md)
prior to submitting a pull request.
---
## Citation
After using the `adaptest` R package, please cite it:
@article{cai2017adaptest,
doi = {},
url = {},
year = {2017},
month = {},
publisher = {The Open Journal},
volume = {submitted},
number = {},
author = {Cai, Weixin and Hubbard, Alan E and Hejazi, Nima S},
title = {adaptest: Data-Adaptive Statistics for High-Dimensional Testing
in R},
journal = {The Journal of Open Source Software}
}
---
## License
The software contents of this repository are distributed under the GPL-2
license. See file `LICENSE` for details.
---
## References