check_package: Run 'R CMD check' on a Package Directory

View source: R/package_functions.R

check_packageR Documentation

Run R CMD check on a Package Directory

Description

This is a wrapper to rcmdcheck::rcmdcheck, signaling notes, warnings and errors.

Usage

check_package(
  package_directory,
  working_directory,
  check_as_cran = TRUE,
  stop_on_check_not_passing = FALSE,
  debug = TRUE
)

Arguments

package_directory

The directory containing the package's source.

working_directory

A working directory. Keep the default.

check_as_cran

Use the --as-cran flag with R CMD check?

stop_on_check_not_passing

Stop if R CMD check does not pass?

debug

For internal use only: Summarize errors for travis?

Value

The return value of rcmdcheck::rcmdcheck.


document documentation built on Aug. 19, 2022, 5:23 p.m.