rhub2
R-hub version 2
R-hub 2 uses GitHub Actions to run R CMD check
and similar package checks.
The rhub2 package helps you set up R-hub 2 for your R package, and start
running checks.
Installation
Once releaseed, install the stable version from CRAN:
install.packages("rhub2")
Usage
Requirements
- A Github account.
- Your R package must be in a GitHub repository.
- You need a GitHub Personal Access Token. You can use the gitcreds package to add the token to the git credential store.
Private repositories
rhub2 uses GitHub Actions, which is free for public repositories. For private repositories you also get some minutes for free, depending on the GitHub subscription you have. See About billing for GitHub Actions for details.
Setup
- Switch to the directory of your package, and call
rhub2::rhub_setup()
to add the R-hub workflow file to your package.
rhub2::rhub_setup()
-
Run
git commit
andgit push
to push the workflow file to GitHub. -
Run
rhub2::rhub_doctor()
to check if everything is set up correctly:
rhub2::rhub_doctor()
Run checks
Use rhub2::rhub_platforms()
to get a list of supported platforms and
checks:
rhub2::rhub_platforms()
Run rhub2::rhub_check()
to start R-hub 2 checks on GitHub Actions:
rhub2::rhub_check()
Code of Conduct
Please note that the callr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
License
MIT © R Consortium