package_magic: Automatically create, update, and validate package files

Description Usage Arguments Examples

View source: R/package_magic.R

Description

Automatically create, update, and validate package files

Usage

1
2
3
4
5
6
7
package_magic(
  quiet = TRUE,
  lang = "en-GB",
  github_actions = TRUE,
  rcmdcheck_args = "--no-manual",
  error_on = "note"
)

Arguments

quiet

Should all output be suppressed?

lang

Preferred spelling language. Usually either "en-US" or "en-GB".

github_actions

Should GitHub Action files be written?

rcmdcheck_args

Passed on to args argument in rcmdcheck::rcmdcheck().

error_on

Whether to throw an error on R CMD check failures. Note that the check is always completed (unless a timeout happens), and the error is only thrown after completion. If "never", then no errors are thrown. If "error", then only ERROR failures generate errors. If "warning", then WARNING failures generate errors as well. If "note", then any check failure generated an error.

Examples

1
2
3
4
## Not run: 
package_magic()

## End(Not run)

and3k/butils documentation built on May 13, 2020, 5:35 a.m.