check_for_cran

0th

Percentile

Check an R-package on R-hub, for a CRAN submission

This function calls check() with arguments and platforms, that are suggested for a CRAN submission. In particular:

  • It checks the package on Windows, and Linux.
  • It checks the package on R-oldrel, R-release and R-devel.
  • It uses the --as-cran argument to R CMD check.
  • It requires all dependencies, including suggested ones.

Usage
check_for_cran(path = ".", email = NULL, check_args = "--as-cran", env_vars = c(`_R_CHECK_FORCE_SUGGESTS_` = "true"), ...)
Arguments
path
Path to a directory containing an R package, or path to source R package tarball built with R CMD check.
email
Email address to send notification to about the build. It must be a validated email address, see validate_email(). If NULL, then the email address of the maintainer is used, as defined in the DESCRIPTION file of the package.
check_args
Arguments for R CMD check. By default --as-cran is used.
env_vars
Environment variables to set on the builder. By default _R_CHECK_FORCE_SUGGESTS_=true is set, to require all packages used.
Value

Return the response from r-hub, invisibly. It contains the URL of the build's status page on r-hub.

Aliases
  • check_for_cran
Documentation reproduced from package rhub, version 1.0.0.9000, License: MIT + file LICENSE

Community examples

Looks like there are no examples yet.