rcmdcheck_process: Run an R CMD check process in the background

Description Usage Arguments Details

Description

rcmdcheck_process is an R6 class, that extends the callr::rcmd_process class (which in turn extends processx::process.

Usage

1
2
3
4
5
cp <- rcmdcheck_process$new(path = ".", args = character(),
         build_args = character(), check_dir = NULL,
         libpath = .libPaths(), repos = getOption("repos"))

cp$parse_results()

Other methods are inherited from callr::rcmd_process and processx::process.

Note that you calling the get_output_connection and get_error_connection method on this is not a good idea, because then the stdout and/or stderr of the process will not be collected for parse_results().

You can still use the read_output_lines() and read_error_lines() methods to read the standard output and error, parse_results() is not affected by that.

Arguments

Details

Most methods are inherited from callr::rcmd_process and processx::process.

cp$parse_results() parses the results, and returns an S3 object with fields errors, warnnigs and notes, just like rcmdcheck(). It is an error to call it before the process has finished. Use the wait() method to wait for the check to finish, or the is_alive() method to check if it is still running.


rcmdcheck documentation built on Sept. 27, 2021, 5:13 p.m.