README.md

In Displayr/flipAPI: Web APIs tools

flipAPI

Web APIs tools

Installation

To install from GitHub:

require(devtools)
install_github("Displayr/flipAPI", dependencies = NA)

If you have not set up a GitHub Personal Access Token, you will likely need to do so to avoid GitHub rate limits, which will manifest as 403 errors when downloading packages via install_github. Please see the documentation in the usethis package or see the instructions here and here.

If you are using Windows, you will need to have a version of Rtools installed that matches your version of R in order to build packages from source. Rtools can be downloaded from here.

Specifying dependencies = NA in install_github will not install packages listed in Suggests in the DESCRIPTION file (some of which may be proprietary and unavailable for download).

Deploying your change (RStudio)

1. Check that your tests pass: Run Tests for any affected test files.
2. Update version in DESCRIPTION.
3. Update documentation Build > More > Document

Submitting a bug report

If you encounter a problem using the package, please open an issue. To achieve a resolution as quickly as possible, please include a minimal, reproducible example of the bug, along with the exact error message or output you receive and the behavior you expect. Including the output of sessionInfo() in R can be helpful to reproduce the issue. Please see this FAQ, which has a number of useful tips on creating great reproducible examples.

Displayr/flipAPI documentation built on April 17, 2024, 9:42 a.m.