rhub_check

R-hub v2 uses GitHub Actions to run 'R CMD check' and
similar package checks. The 'rhub' package helps you set up
R-hub v2 for your R package, and start running checks.

Gabor Csardi

rhub

Tools for R Package Developers

Gábor Csárdi

Maëlle Salmon

R Consortium 

rhub_check function

<dl><dt>gh_url</dt>
<dd>GitHub URL of a package to check, or <code>NULL</code> to check
the package in the current directory.</dd>
<dt>platforms</dt>
<dd>Platforms to use, a character vector. Use <code>NULL</code> to
select from a list in interactive sessions. See <code>rhub_platforms()</code>.</dd>
<dt>r_versions</dt>
<dd>Which R version(s) to use for the platforms that
supports multiple R versions. This argument is not implemented yet.</dd>
<dt>branch</dt>
<dd>Branch to use to run R-hub. Defaults to the current
branch if <code>gh_url</code> is <code>NULL</code>. Otherwise defaults to <code>"main"</code>. Note that
this branch also need to include the <code>rhub.yaml</code> workflow file.</dd></dl>

Arguments

Check a package on R-hub — rhub_check

<dl>

<dt>gh_url</dt>
<dd>GitHub URL of a package to check, or <code>NULL</code> to check
the package in the current directory.</dd>


<dt>platforms</dt>
<dd>Platforms to use, a character vector. Use <code>NULL</code> to
select from a list in interactive sessions. See <code>rhub_platforms()</code>.</dd>


<dt>r_versions</dt>
<dd>Which R version(s) to use for the platforms that
supports multiple R versions. This argument is not implemented yet.</dd>


<dt>branch</dt>
<dd>Branch to use to run R-hub. Defaults to the current
branch if <code>gh_url</code> is <code>NULL</code>. Otherwise defaults to <code>"main"</code>. Note that
this branch also need to include the <code>rhub.yaml</code> workflow file.</dd>

</dl>

rhub_check: Check a package on R-hub

Description

Usage

Value

Arguments