Skip to contents

Run the complete set of standardised tests on a package

Source: R/check_package.R
check_package.Rd

A convenience function that runs all packages related tests in sequence. The details section lists the relevant functions. After fixing a problem, you can quickly check if it is solved by running only the related check. But we still recommend to run check_package() before you push to GitHub. And only push when the functions indicate that there are no problems. This catches most problems before sending the code to GitHub.

Usage

check_package(
  x = ".",
  fail = !interactive(),
  pkgdown = interactive(),
  quiet = FALSE
)

Arguments

x

Either a checklist object or a path to the source code. Defaults to ..

fail

Should the function return an error in case of a problem? Defaults to TRUE on a non-interactive session and FALSE on an interactive session.

pkgdown

Test pkgdown website. Defaults to TRUE on an interactive session and FALSE on a non-interactive session.

quiet

Whether to print check output during checking.

Details

List of checks in order:

  1. check_cran()

  2. check_lintr()

  3. check_filename()

  4. check_description()

  5. check_documentation()

  6. check_codemeta()

See also

Other package: check_codemeta(), check_cran(), check_description(), check_documentation(), check_environment(), check_license(), set_tag(), tidy_desc(), update_citation(), write_citation_cff(), write_zenodo_json()