Skip to content

Latest commit

 

History

History
49 lines (26 loc) · 1.71 KB

README.md

File metadata and controls

49 lines (26 loc) · 1.71 KB

proofr

Project Status: Concept – Not useable, no support, not open to feedback, unstable API. R-CMD-check codecov

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 with:

# install.packages("pak")
pak::pak("getwilds/proofr")

Get started

To get started with proofr, see the Getting Started vignette.

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.
  • Base URL: The base URL for the PROOF API can be changed by setting the environment variable PROOF_API_BASE_URL. It can be set for an R session or for function by function use as we check that env var in each function call to the API.

Bugs? Features?

Open an issue on our issue tracker.

Code of Conduct

Please note that the proofr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

MIT