A simple (unofficial) R package for interacting with the CIViC DB API.
See the official CIViC DB API Documentation for more detailed information on the API.
Benefits of using this package
- Don’t have to write your own functions to talk to the CIViC API
- Response objects stored as custom S3 objects
- HTTP errors are converted to R errors
Contributing
Any contribution is much appreciated, whether it be in the form of bug reports or pull requests.
Bug Reports/Feature Requests
If you find any bugs or have any feature requests then please create an issue in this repository.
Building package
- Open a terminal and go to
./civicr/ - Run
R CMD build civicr - Run
R CMD INSTALL civicr_<version>.tar.gz - Check that it passes CRAN checks
R CMD check --as-cran civicr_<version>.tar.gz
Updating documentation
- Go to RStudio and open the project
- Load devtools
library(devtools) - Setwd to
./civicr/civicr - Run document()
