Skip to content

Latest commit

 

History

History
 
 

check-r-package

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

check-r-package

RStudio community

This action checks an R package using the rcmdcheck package.

Usage

Inputs available:

  • args - default c("--no-manual", "--as-cran"). Arguments to pass to the args parameter of rcmdcheck. It must be an R expression in single quotes.
  • build_args - default "--no-manual". Arguments to pass to the build_args parameter of rcmdcheck. it must be an R expression in single quotes.
  • check-dir - default "check". Arguments to pass to the check-dir parameter of rcmdcheck. It must be an R expression in single quotes.
  • error-on - default "warning". Arguments to pass to the error-on parameter of rcmdcheck. It must be an R expression in single quotes.
  • upload-artifacts - default false. Whether to upload all testthat snapshots as an artifact.
  • working-directory - default ".". If the R package to check is not in the root directory of your repository.

Basic:

steps:
- uses: actions/checkout@v2
- uses: r-lib/actions/setup-r@v2
- uses: r-lib/actions/setup-r-dependencies@v2
  with:
    extra-packages: rcmdcheck
- uses: r-lib/actions/check-r-package@v2

License

The scripts and documentation in this project are released under the MIT License

Contributions

Contributions are welcome!