-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
56 lines (34 loc) · 1.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
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r include=FALSE}
knitr::opts_chunk$set(
comment = "#>",
collapse = TRUE,
warning = FALSE,
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# proofr
<!-- badges: start -->
[![Project Status: Concept – Not useable, no support, not open to feedback, unstable API.](https://getwilds.github.io/badges/badges/concept.svg)](https://getwilds.github.io/badges/#concept)
[![R-CMD-check](https://github.com/getwilds/proofr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/getwilds/proofr/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/getwilds/proofr/graph/badge.svg?token=G5QFLURUZ4)](https://codecov.io/gh/getwilds/proofr)
<!-- badges: end -->
R client for the PROOF API
PROOF API is at <https://github.com/FredHutch/proof-api>
## Installation
You can install the development version of proofr from [GitHub](https://github.com/) with:
```r
# install.packages("pak")
pak::pak("getwilds/proofr")
```
## Get started
To get started with `proofr`, see the [Getting Started vignette](https://getwilds.org/proofr/articles/proofr.html).
## Notes
- There are no plans to submit this package to CRAN. Therefore, you should not depend on this package in any packages you have on CRAN.
## Bugs? Features?
Open an issue on our [issue tracker](https://github.com/getwilds/proofr/issues/).
## Code of Conduct
Please note that the proofr project is released with a [Contributor Code of Conduct](http://getwilds.org/proofr/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
## License
[MIT](LICENSE.md)