Start here to learn about R-hub v2, especially if you used the previous version of R-hub before.
R-hub v2, i.e. version 2 or later of the rhub package is a completely new check system. In this acticle we highlight the differences between the old and the new system.
There are two ways to use R-hub v2. The recommended way is to store your
R package in a GitHub repository and use the rhub_*() functions to
start checks on GitHub Actions, using your own GitHub account.
Alternatively, if you don't want to store your R package at GitHub, you
can use the rc_*() functions to run checks in a shared GitHub
organization at https://github.com/r-hub2, using the R Consortium runners.
See more about the R Consortium runners below.
First, you need a GitHub account.
Second, you need to have your R package in a GitHub repository.
In your local git clone make sure that the origin git remote is set
to the GitHub repository.
Third, you need a GitHub Personal Access Token
and you need to store it in the git credential store on your machine.
You can use gitcreds::gitcreds_set() to add the token to the git
credential store.
Call rhub_setup() from the local git clone to set up R-hub v2 for your
package. This adds a GitHub Actions workflow to your local repository.
Push this change to GitHub, into your default git branch and then you
are ready to call start checks with rhub_check().
The check picks up the package from GitHub, so it does not use
changes in your local git clone. You need to push the changes to
GitHub first. You can use a non-default branch, with the branch
argument of rhub_check().
You'll not get an email about the check results. But you'll receive regular GitHub notifications about check failures, unless you opt out. Github can also turn these into emails if you like.
There is no live output from the check at the R console. See the 'Actions' tab of your repository on GitHub for a live check log.
Many more specialized platforms are available.
Most platforms use binary packages, so checks and in particular installing dependencies is much faster.
GitHub Actions 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.
If you don't want to put your package on GitHub, you can still use the rhub package to run package checks on any supported platform using a shared pool of runners in the https://github.com/r-hub2 GitHub organization.
The process is similar to the first version of R-hub:
Set your working directory to the R package you want to check.
Obtain a token from R-hub, to verify your email address:
(You do not need to do this, if you already submitted packages to a
previous version of R-hub from the same machine, using the same email
address. Call rc_list_local_tokens() to check if you already have
tokens.)
Submit a build with
Select the platforms you want to use, and follow the instructions and the link provided to see your check results.
You package will be public for the world, and will be stored in the
https://github.com/r-hub2 organization. Your check output and results
will be public for anyone with a GitHub account. If you want to keep
your package private, you can put it in a private GitHub repository,
and use the rhub_setup() and rhub_check() functions instead.
The R Consortium runners are shared among all users, so you might need to wait for your builds to start.
You have to wait at least five minutes between submissions with
rc_submit().
Currently you need to create a GitHub account to see the check logs of your package. You don't need a GitHub account to submit the checks.
To avoid these limitations (except for the neeed for a GitHub accounr),
put your package in a GitHub repository, and use the rhub_setup() and
rhub_check() functions instead of rc_submit() and the R Consortium
runners.