https://github.com/getwilds/proofr

Client for the PROOF API
https://github.com/getwilds/proofr

r-package wilds-r

Last synced: over 1 year ago
JSON representation

Client for the PROOF API

• Host: GitHub
• URL: https://github.com/getwilds/proofr
• Owner: getwilds
• License: other
• Created: 2024-01-05T22:43:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-03T22:32:11.000Z (over 1 year ago)
• Last Synced: 2024-12-03T23:27:01.630Z (over 1 year ago)
• Topics: r-package, wilds-r
• Language: R
• Homepage: http://getwilds.org/proofr/
• Size: 7.01 MB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


```{r include=FALSE}

knitr::opts_chunk$set(

  comment = "#>",

  collapse = TRUE,

  warning = FALSE,

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# proofr

[![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)

R client for the PROOF API

PROOF API is at 

## 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.

- 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](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)