### Programmatic usage
`rcmdcheck()` returns an `rcmdcheck` object, which you can query and
manipulate.
``` r
library(rcmdcheck)
chk <- rcmdcheck("tests/testthat/bad1", quiet = TRUE)
chk
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────── badpackage 1.0.0 ────
#> Duration: 12.4s
#>
#> ❯ checking DESCRIPTION meta-information ... WARNING
#> Non-standard license specification:
#> Public domain
#> Standardizable: FALSE
#>
#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔
```
`check_details()` turns the check results into a simple lists with the
following information currently:
``` r
names(check_details(chk))
#> [1] "package" "version" "notes" "warnings" "errors"
#> [6] "platform" "checkdir" "install_out" "description" "session_info"
#> [11] "cran" "bioc"
```
- `package`: Package name.
- `version`: Package version number.
- `notes`: Character vector of check `NOTE`s.
- `warnings`: Character vector of check `WARNING`s.
- `errors`: Character vector of check `ERROR`s.
- `platform`: Platform, e.g. `x86_64-apple-darwin15.6.0`.
- `checkdir`: Check directory.
- `install_out`: Output of the package installation.
- `description`: The text of the `DESCRIPTION` file.
- `session_info`: A `sessioninfo::session_info` object, session
information from within the check process.
- `cran`: Flag, whether this is a CRAN package. (Based on the
`Repository` field in `DESCRIPTION`, which is typically only set for
published CRAN packages.)
- `bioc`: Flag, whether this is a Bioconductor package, based on the
presence of the `biocViews` field in `DESCRIPTION`.
Note that if the check results were parsed from a file, some of these
fields might be missing (`NULL`), as we don’t have access to the
original `DESCRIPTION`, the installation output, etc.
### Parsing check output
`parse_check()` parses check output from a file, `parse_check_url()`
parses check output from a URL.
### CRAN checks
rcmdcheck has a functions to access CRAN’s package check results.
`cran_check_flavours()` downloads the names of the CRAN platforms:
``` r
cran_check_flavours()
#> [1] "r-devel-linux-x86_64-debian-clang" "r-devel-linux-x86_64-debian-gcc"
#> [3] "r-devel-linux-x86_64-fedora-clang" "r-devel-linux-x86_64-fedora-gcc"
#> [5] "r-devel-windows-x86_64" "r-patched-linux-x86_64"
#> [7] "r-patched-solaris-x86" "r-release-linux-x86_64"
#> [9] "r-release-macos-arm64" "r-release-macos-x86_64"
#> [11] "r-release-windows-ix86+x86_64" "r-oldrel-macos-x86_64"
#> [13] "r-oldrel-windows-ix86+x86_64"
```
`cran_check_results()` loads and parses all check results for a package.
``` r
cran_check_results("igraph")
#> $`r-devel-linux-x86_64-debian-clang`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking top-level files ... WARNING
#> Output from running autoreconf:
#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:71: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:71: the top level
#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:110: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:110: the top level
#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:127: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:127: the top level
#>
#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔
#>
#> $`r-devel-linux-x86_64-debian-gcc`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking top-level files ... WARNING
#> Output from running autoreconf:
#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:71: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:71: the top level
#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:110: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:110: the top level
#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:127: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:127: the top level
#>
#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔
#>
#> $`r-devel-linux-x86_64-fedora-clang`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 16.9Mb
#> sub-directories of 1Mb or more:
#> R 1.4Mb
#> help 1.1Mb
#> libs 14.0Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-devel-linux-x86_64-fedora-gcc`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔
#>
#> $`r-devel-windows-x86_64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 9.8Mb
#> sub-directories of 1Mb or more:
#> R 1.4Mb
#> help 1.1Mb
#> libs 6.9Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-devel-windows-x86_64-gcc10-UCRT`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking whether package 'igraph' can be installed ... ERROR
#> See below...
#>
#> ❯ checking package dependencies ... NOTE
#> Package suggested but not available for checking: 'rgl'
#>
#> ── Install failure ───────────────────────────────────────────────────────────────────────────────────────────────────────
#>
#> <00install.out file does not exist>
#> 1 error ✖ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-patched-linux-x86_64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking top-level files ... WARNING
#> Output from running autoreconf:
#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:71: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:71: the top level
#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:110: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:110: the top level
#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:127: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:127: the top level
#>
#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔
#>
#> $`r-patched-solaris-x86`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 9.6Mb
#> sub-directories of 1Mb or more:
#> R 1.5Mb
#> help 1.2Mb
#> libs 6.5Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-release-linux-x86_64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking top-level files ... WARNING
#> Output from running autoreconf:
#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:71: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:71: the top level
#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:110: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:110: the top level
#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.
#> configure.ac:127: You should run autoupdate.
#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...
#> configure.ac:127: the top level
#>
#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔
#>
#> $`r-release-macos-arm64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 23.7Mb
#> sub-directories of 1Mb or more:
#> R 2.0Mb
#> help 1.1Mb
#> libs 20.0Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-release-macos-x86_64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 21.2Mb
#> sub-directories of 1Mb or more:
#> R 1.4Mb
#> help 1.1Mb
#> libs 18.3Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-release-windows-ix86+x86_64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 17.1Mb
#> sub-directories of 1Mb or more:
#> R 1.4Mb
#> help 1.1Mb
#> libs 14.2Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-oldrel-macos-x86_64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 21.2Mb
#> sub-directories of 1Mb or more:
#> R 1.4Mb
#> help 1.1Mb
#> libs 18.3Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> $`r-oldrel-windows-ix86+x86_64`
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────
#> Duration: 0ms
#>
#> ❯ checking installed package size ... NOTE
#> installed size is 17.1Mb
#> sub-directories of 1Mb or more:
#> R 1.4Mb
#> help 1.1Mb
#> libs 14.2Mb
#>
#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖
#>
#> attr(,"package")
#> [1] "igraph"
#> attr(,"class")
#> [1] "rmcdcheck_cran_results"
```
### Comparing checks
`compare_checks()` can compare two or more `rcmdcheck` objects.
`compare_to_cran()` compares an `rcmdcheck` object to the CRAN checks of
the same package:
``` r
chk <- rcmdcheck(quiet = TRUE)
compare_to_cran(chk)
#> ── R CMD check comparison ────────────────────────────────────────────────────────────── rcmdcheck 1.3.3 / 1.3.3.9000 ────
#> Status: OK
#>
#> ── Fixed
#>
#> ✔ checking LazyData ... NOTE
#> ✔ checking LazyData ... NOTE
#> ✔ checking LazyData ... NOTE
#> ✔ checking LazyData ... NOTE
#> ✔ checking LazyData ... NOTE
#> ✔ checking LazyData ... NOTE
```
### Background processes
`rcmdcheck_process` is a `processx::process` class, that can run `R CMD
check` in the background. You can also use this to run multiple checks
concurrently. `processx::process` methods can be used to poll or
manipulate the check processes.
``` r
chkpx <- rcmdcheck_process$new()
chkpx
#> PROCESS 'R', running, pid 82576.
```
``` r
chkpx$wait()
chkpx$parse_results()
#> ── R CMD check results ───────────────────────────────────────────────────────────────────────── rcmdcheck 1.3.3.9000 ────
#> Duration: 23.6s
#>
#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔
```
## License
MIT © Mango Solutions, Gábor Csárdi, RStudio
rcmdcheck/man/ 0000755 0001762 0000144 00000000000 14123052257 012751 5 ustar ligges users rcmdcheck/man/rcmdcheck-config.Rd 0000644 0001762 0000144 00000010760 14122343700 016425 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/options.R
\name{rcmdcheck-config}
\alias{rcmdcheck-config}
\title{rcmdcheck configuration}
\description{
Options take precedence over environment variables. E.g. if both
the \code{RCMDCHECK_NUM_COLORS} environment variables and the
\code{rcmdcheck.num_colors} option are set, then the latter is used.
}
\details{
rcmdcheck uses the cli package for much of its output, so you can
configure the output via cli, see \link[cli:cli-config]{cli::cli-config}.
Package configration is defined in the \code{DESCRIPTION} file of the checked
package. E.g.:\preformatted{Config/build/clean-inst-doc: FALSE
}
}
\section{Environment variables}{
\itemize{
\item \code{R_PROFILE_USER}: standard R environment variable to configure the
path to the user level R profile. See \link[base:Startup]{base::R_PROFILE_USER}.
\item \code{RCMDCHECK_BASE_URL}: URL to the root of the CRAN check web page.
You can use this to select an alternative CRAN mirror. Defaults to
\verb{https://cran.r-project.org/web/checks/}.
\item \code{RCMDCHECK_DETAILS_URL}: URL to the root of the CRAN check output
page. Defaults to \verb{https://www.r-project.org/nosvn/R.check/}.
\item \code{RCMDCHECK_ERROR_ON}: the default value for the \code{error_on} argument
of \code{\link[=rcmdcheck]{rcmdcheck()}}.
\item \code{RCMDCHECK_FLAVOURS_URL} URL to the CRAN check flavours page.
You can use this to select an alternative CRAN mirror. Defaults to
\verb{https://cran.r-project.org/web/checks/check_flavors.html}.
\item \code{RCMDCHECK_NUM_COLORS}: the number of ANSI colors to use in the output.
It can be used to override the number of colors detected or configured
by the cli package. See \code{\link[cli:num_ansi_colors]{cli::num_ansi_colors()}}. This configuration
is only used for the output of rcmdcheck and it does not affect the
examples and test cases (and other code) of the checked package.
It not set, then the default of cli is uesed. The corresponding
option is \code{rcmdcheck.num_colors}.
\item \code{RCMDCHECK_TIMESTAMP_LIMIT}: lower limit is seconds, above which
rcmdcheck adds time stamps to the individual check steps. It may be
fractional. Defaults to 1/3 of a second. The corresponding option is
\code{rcmdcheck.timestamp_limit}.
\item \code{RCMDCHECK_USE_RSTUDIO_PANDOC}: Flag (\code{true} or \code{false}). If \code{true},
then rcmdcheck \emph{always} puts RStudio's pandoc (if available) on the
path. If \code{false}, then it \emph{never} does that. If not set, or set to a
different value, then pandoc is put on the path only if it is not
already available. RStudio's pandoc is detected via an \code{RSTUDIO_PANDOC}
environment variable.
\item \code{RCMDCHECK_LOAD_CHECK_ENV}: you can use this environment variable
suppress loading environment variables from the \code{tools/check.env} file.
See \code{\link[=rcmdcheck]{rcmdcheck()}} for details.
\item \code{RSTUDIO_PANDOC}: if set, rcmdcheck adds this environment variable
to the PATH if pandoc is not on the PATH already. It is usually set
in RStudio. See also the \code{RCMDCHECK_USE_RSTUDIO_PANDOC} environment
variable.
}
}
\section{Options}{
\itemize{
\item \code{rcmdcheck.num_colors}: the number of ANSI colors to use in the output.
It can be used to override the number of colors detected or configured
by the cli package. See \code{\link[cli:num_ansi_colors]{cli::num_ansi_colors()}}. This configuration
is only used for the output of rcmdcheck and it does not affect the
examples and test cases (and other code) of the checked package.
It not set, then the default of cli is uesed. The corresponding
environment variable is \code{RCMDCHECK_NUM_COLORS}.
\item \code{rcmdcheck.test_output}: Flag (\code{TRUE} or \code{FALSE}), whether
\code{\link[=print.rcmdcheck]{print.rcmdcheck()}} should print the full test output if there are
no test failures. If some tests fail, then only the failures are
printed, independently of this option.
\item \code{rcmdcheck.timestamp_limit}: lower limit is seconds, above which
rcmdcheck adds time stamps to the individual check steps. It may be
fractional. Defaults to 1/3 of a second. The corresponding environment
variable is \code{RCMDCHECK_TIMESTAMP_LIMIT}.
}
}
\section{Package configuration:}{
\itemize{
\item \code{Config/build/clean-inst-doc}: Flag (\code{TRUE} or \code{FALSE}) to
specify if the \code{inst/doc} directory should be cleaned up when
building a package directory. If not specified, then \code{NULL} is used.
See the \code{clean_doc} option of \code{\link[pkgbuild:build]{pkgbuild::build()}} for more details.
}
}
rcmdcheck/man/print.rcmdcheck.Rd 0000644 0001762 0000144 00000001212 14120347676 016323 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/print.R
\name{print.rcmdcheck}
\alias{print.rcmdcheck}
\title{Print R CMD check results}
\usage{
\method{print}{rcmdcheck}(
x,
header = TRUE,
test_output = getOption("rcmdcheck.test_output", FALSE),
...
)
}
\arguments{
\item{x}{Check result object to print.}
\item{header}{Whether to print a header.}
\item{test_output}{if \code{TRUE}, include the test output in the results,
if there are no test failures. If some tests fail, then only the
failures are printed.}
\item{...}{Additional arguments, currently ignored.}
}
\description{
Print R CMD check results
}
rcmdcheck/man/compare_checks.Rd 0000644 0001762 0000144 00000001566 14120347676 016227 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/compare.R
\name{compare_checks}
\alias{compare_checks}
\title{Compare a set of check results to another check result}
\usage{
compare_checks(old, new)
}
\arguments{
\item{old}{A check result, or a list of check results.}
\item{new}{A check result.}
}
\value{
An \code{rcmdcheck_comparison} object with fields:
\itemize{
\item \code{package}: the name of the package, string,
\item \code{versions}: package versions, length two character,
\item \code{status}: comparison status, see below,
\item \code{old}: list of \code{rcmdcheck} objects the old check(s),
\item \code{new}: \code{rcmdcheck} object, the new check,
\item \code{cmp}:
}
}
\description{
Compare a set of check results to another check result
}
\seealso{
Other check comparisons:
\code{\link{compare_to_cran}()}
}
\concept{check comparisons}
rcmdcheck/man/print.rcmdcheck_comparison.Rd 0000644 0001762 0000144 00000001221 13146514764 020556 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/comparison.R
\name{print.rcmdcheck_comparison}
\alias{print.rcmdcheck_comparison}
\title{Print R CMD check result comparisons}
\usage{
\method{print}{rcmdcheck_comparison}(x, header = TRUE, ...)
}
\arguments{
\item{x}{R CMD check result comparison object.}
\item{header}{Whether to print the header. You can suppress the
header if you want to use the printout as part of another object's
printout.}
\item{...}{Additional arguments, currently ignored.}
}
\description{
See \code{\link[=compare_checks]{compare_checks()}} and \code{\link[=compare_to_cran]{compare_to_cran()}}.
}
rcmdcheck/man/parse_check.Rd 0000644 0001762 0000144 00000001413 14120347676 015517 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/parse.R
\name{parse_check}
\alias{parse_check}
\title{Parse \code{R CMD check} results from a file or string}
\usage{
parse_check(file = NULL, text = NULL, ...)
}
\arguments{
\item{file}{The \code{00check.log} file, or a directory that
contains that file. It can also be a connection object.}
\item{text}{The contents of a \code{00check.log} file.}
\item{...}{Other arguments passed onto the constructor.
Used for testing.}
}
\value{
An \code{rcmdcheck} object, the check results.
}
\description{
At most one of \code{file} or \code{text} can be given.
If both are \code{NULL}, then the current working directory
is checked for a \code{00check.log} file.
}
\seealso{
\code{\link{parse_check_url}}
}
rcmdcheck/man/data_frame.Rd 0000644 0001762 0000144 00000001240 14120347676 015331 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{data_frame}
\alias{data_frame}
\title{Alternative to data.frame}
\usage{
data_frame(..., stringsAsFactors = FALSE)
}
\arguments{
\item{...}{Named data frame columns, or data frames.}
\item{stringsAsFactors}{Just leave it on \code{FALSE}. \verb{:)}}
}
\value{
Data frame.
}
\description{
\itemize{
\item Sets stringsAsFactors to FALSE by default
\item If any columns have zero length, the result will have
zero rows.
\item If a column is a scalar, then it will be recycled.
\item Non-matching number of rows gives an error, except for
lengths zero and one.
}
}
\keyword{internal}
rcmdcheck/man/parse_check_url.Rd 0000644 0001762 0000144 00000001071 14120347676 016401 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/parse.R
\name{parse_check_url}
\alias{parse_check_url}
\title{Shorthand to parse R CMD check results from a URL}
\usage{
parse_check_url(url, quiet = FALSE)
}
\arguments{
\item{url}{URL to parse the results from. Note that it should
not contain HTML markup, just the text output.}
\item{quiet}{Passed to \code{download.file}.}
}
\value{
An \code{rcmdcheck} object, the check results.
}
\description{
Shorthand to parse R CMD check results from a URL
}
\seealso{
\code{\link{parse_check}}
}
rcmdcheck/man/rcmdcheck.Rd 0000644 0001762 0000144 00000012436 14123052470 015166 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/package.R
\docType{package}
\name{rcmdcheck}
\alias{rcmdcheck}
\title{Run R CMD check from R and Capture Results}
\usage{
rcmdcheck(
path = ".",
quiet = FALSE,
args = character(),
build_args = character(),
check_dir = NULL,
libpath = .libPaths(),
repos = getOption("repos"),
timeout = Inf,
error_on = Sys.getenv("RCMDCHECK_ERROR_ON", c("never", "error", "warning",
"note")[1]),
env = character()
)
}
\arguments{
\item{path}{Path to a package tarball or a directory.}
\item{quiet}{Whether to print check output during checking.}
\item{args}{Character vector of arguments to pass to \verb{R CMD check}. Pass each
argument as a single element of this character vector (do not use spaces to
delimit arguments like you would in the shell). For example, to skip
running of examples and tests, use \code{args = c("--no-examples", "--no-tests")} and not \code{args = "--no-examples --no-tests"}. (Note that
instead of the \code{--output} option you should use the \code{check_dir} argument,
because \code{--output} cannot deal with spaces and other special characters on
Windows.)}
\item{build_args}{Character vector of arguments to pass to \verb{R CMD build}.
Pass each argument as a single element of this character vector (do not use
spaces to delimit arguments like you would in the shell). For example,
\code{build_args = c("--force", "--keep-empty-dirs")} is a correct usage and
\code{build_args = "--force --keep-empty-dirs"} is incorrect.}
\item{check_dir}{Path to a directory where the check is performed.
If this is not \code{NULL}, then the a temporary directory is used, that
is cleaned up when the returned object is garbage collected.}
\item{libpath}{The library path to set for the check.
The default uses the current library path.}
\item{repos}{The \code{repos} option to set for the check.
This is needed for cyclic dependency checks if you use the
\code{--as-cran} argument. The default uses the current value.}
\item{timeout}{Timeout for the check, in seconds, or as a
\link[base:difftime]{base::difftime} object. If it is not finished before this, it will be
killed. \code{Inf} means no timeout. If the check is timed out,
that is added as an extra error to the result object.}
\item{error_on}{Whether to throw an error on \verb{R CMD check} failures.
Note that the check is always completed (unless a timeout happens),
and the error is only thrown after completion. If \code{"never"}, then
no errors are thrown. If \code{"error"}, then only \code{ERROR} failures
generate errors. If \code{"warning"}, then \code{WARNING} failures generate
errors as well. If \code{"note"}, then any check failure generated an
error. Its default can be modified with the \code{RCMDCHECK_ERROR_ON}
environment variable. If that is not set, then \code{"never"} is used.}
\item{env}{A named character vector, extra environment variables to
set in the check process.}
}
\value{
An S3 object (list) with fields \code{errors},
\code{warnings} and \code{notes}. These are all character
vectors containing the output for the failed check.
}
\description{
Run R CMD check from R programmatically, and capture the results of the
individual checks.
Runs \verb{R CMD check} as an external command, and parses its output and
returns the check failures.
}
\details{
See \link{rcmdcheck_process} if you need to run \verb{R CMD check} in a background
process.
}
\section{Turning off package checks}{
Sometimes it is useful to programmatically turn off some checks that
may report check NOTEs.
rcmdcehck provides two ways to do this.
First, you may declare in \code{DESCRIPTION} that you don't want to see
NOTEs that are accepted on CRAN, with this entry:\preformatted{Config/rcmdcheck/ignore-inconsequential-notes: true
}
Currently, this will make rcmdcheck ignore the following notes:
\itemize{
\item report large package sizes (\verb{_R_CHECK_PKG_SIZES_ = FALSE}),
\item check cross-references in Rd files (\verb{_R_CHECK_RD_XREFS_ = FALSE}),
\item NOTE if package requires GNU make (\verb{_R_CHECK_CRAN_INCOMING_NOTE_GNU_MAKE_ = FALSE}),
\item report marked non-ASCII strings in datasets (\verb{_R_CHECK_PACKAGE_DATASETS_SUPPRESS_NOTES_ = TRUE}).
}
The second way is more flexible, and lets you turn off individual checks
via setting environment variables.
You may provide a \code{tools/check.env} \emph{environment file} in your package
with the list of environment variable settings that rcmdcheck will
automatically use when checking the package.
See \link{Startup} for the format of this file.
Here is an example \code{tools/check.env} file:\preformatted{# Report if package size is larger than 10 megabytes
_R_CHECK_PKG_SIZES_THRESHOLD_=10
# Do not check Rd cross references
_R_CHECK_RD_XREFS_=false
# Do not report if package requires GNU make
_R_CHECK_CRAN_INCOMING_NOTE_GNU_MAKE_=false
# Do not check non-ASCII strings in datasets
_R_CHECK_PACKAGE_DATASETS_SUPPRESS_NOTES_=true
}
See the \href{https://cran.r-project.org/doc/manuals/r-devel/R-ints.html}{"R internals" manual}
and the \href{https://github.com/wch/r-source}{R source code} for the
environment variables that control the checks.
Note that \code{Config/rcmdcheck/ignore-inconsequential-notes} and the
\code{check.env} file are only supported by rcmdcheck, and running
\verb{R CMD check} from a shell (or GUI) will not use them.
}
rcmdcheck/man/cran_check_results.Rd 0000644 0001762 0000144 00000001222 14120347676 017107 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cran.R
\name{cran_check_results}
\alias{cran_check_results}
\title{Download and parse R CMD check results from CRAN}
\usage{
cran_check_results(
package,
flavours = cran_check_flavours(package),
quiet = FALSE
)
}
\arguments{
\item{package}{Name of a single package to download the checks for.}
\item{flavours}{CRAN check flavours to use. Defaults to all
flavours that were used to check the package.}
\item{quiet}{Whether to omit the download progress bars.}
}
\value{
A list of \code{rcmdcheck} objects.
}
\description{
Download and parse R CMD check results from CRAN
}
rcmdcheck/man/check_details.Rd 0000644 0001762 0000144 00000002765 14120347676 016045 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api.R
\name{check_details}
\alias{check_details}
\title{Query R CMD check results and parameters}
\usage{
check_details(check)
}
\arguments{
\item{check}{A check result.}
}
\value{
A named list with elements:
\itemize{
\item \code{package}: package name.
\item \code{version}: package version.
\item \code{rversion}: R version.
\item \code{notes}: character vector of check NOTEs, each NOTE is an
element.
\item \code{warnings}: character vector of check WARNINGs, each WARNING is an
element.
\item \code{errors}: character vector of check ERRORs, each ERROR is an element.
A check timeout adds an ERROR to this vector.
\item \code{platform}: check platform
\item \code{checkdir}: check directory.
\item \code{install_out}: the output of the installation, contents of the
\verb{00install.out} file. A single string.
\item \code{description}: the contents of the DESCRIPTION file of the package.
A single string.
\item \code{session_info}: the output of \code{\link[sessioninfo:session_info]{sessioninfo::session_info()}},
from the R session performing the checks.
\item \code{checkdir}: the path to the check directory, if it hasn't been
cleaned up yet, or \code{NA}. The check directory is automatically
cleaned up, when the check object is deleted (garbage collected).
\item \code{cran}: whether it is a CRAN packaged package.
\item \code{bioc}: whether it is a BioConductor package.
}
}
\description{
Query R CMD check results and parameters
}
rcmdcheck/man/rcmdcheck_process.Rd 0000644 0001762 0000144 00000004524 14123052257 016726 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/background.R
\name{rcmdcheck_process}
\alias{rcmdcheck_process}
\title{Run an \verb{R CMD check} process in the background}
\description{
rcmdcheck_process is an R6 class, that extends the
\link[callr:rcmd_process]{callr::rcmd_process} class (which in turn extends \link[processx:process]{processx::process}.
}
\section{Usage}{
\preformatted{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 \link[callr:rcmd_process]{callr::rcmd_process} and
\link[processx:process]{processx::process}.
Note that you calling the \code{get_output_connection} and
\code{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 \code{parse_results()}.
You can still use the \code{read_output_lines()} and \code{read_error_lines()}
methods to read the standard output and error, \code{parse_results()} is
not affected by that.
}
\section{Arguments}{
\itemize{
\item \code{cp}: A new rcmdcheck_process object.
\item \code{path}: Path to a package tree or a package archive file. This is the
package to check.
\item \code{args}: Command line arguments to \verb{R CMD check}.
\item \code{build_args}: Command line arguments to \verb{R CMD build}.
\item \code{check_dir}: Directory for the results.
\item \code{libpath}: The library path to set for the check.
\item \code{repos}: The \code{repos} option to set for the check.
This is needed for cyclic dependency checks if you use the
\code{--as-cran} argument. The default uses the current value.
\item \code{env}: A named character vector, extra environment variables to
set in the check process.
}
}
\section{Details}{
Most methods are inherited from \link[callr:rcmd_process]{callr::rcmd_process} and
\link[processx:process]{processx::process}.
\code{cp$parse_results()} parses the results, and returns an S3 object with
fields \code{errors}, \code{warnnigs} and \code{notes}, just like \code{\link[=rcmdcheck]{rcmdcheck()}}. It
is an error to call it before the process has finished. Use the
\code{wait()} method to wait for the check to finish, or the \code{is_alive()}
method to check if it is still running.
}
rcmdcheck/man/cran_check_flavours.Rd 0000644 0001762 0000144 00000001256 14120347676 017256 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cran.R
\name{cran_check_flavours}
\alias{cran_check_flavours}
\title{Download and show all CRAN check flavour platforms}
\usage{
cran_check_flavours(package = NULL)
}
\arguments{
\item{package}{CRAN package name or \code{NULL}.}
}
\value{
Character vector of platform ids.
}
\description{
If the \code{package} argument is \code{NULL}, then all current
platforms are downloaded. If the \code{package} argument is specified,
then all flavours used for the latest package checks for that
package, are downloaded and returned.
}
\examples{
\dontrun{
cran_check_flavours()
cran_check_flavours("simplegraph")
}
}
rcmdcheck/man/myrep.Rd 0000644 0001762 0000144 00000000572 13142421221 014367 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R
\name{myrep}
\alias{myrep}
\title{Recycle a vector or a data frame (rows)}
\usage{
myrep(x, len)
}
\arguments{
\item{x}{Vector or data frame to replicate. Must be length 0, 1, or
len.}
\item{len}{Expected length.}
}
\description{
Recycle a vector or a data frame (rows)
}
\keyword{internal}
rcmdcheck/man/compare_to_cran.Rd 0000644 0001762 0000144 00000001131 14120347676 016400 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/compare.R
\name{compare_to_cran}
\alias{compare_to_cran}
\title{Compare a check result to CRAN check results}
\usage{
compare_to_cran(check, flavours = cran_check_flavours(check$package))
}
\arguments{
\item{check}{A check result.}
\item{flavours}{CRAN check flavour(s) to use. By default all
platforms are used.}
}
\value{
An \code{rmdcheck_comparison} object.
}
\description{
Compare a check result to CRAN check results
}
\seealso{
Other check comparisons:
\code{\link{compare_checks}()}
}
\concept{check comparisons}
rcmdcheck/man/xopen.rcmdcheck.Rd 0000644 0001762 0000144 00000001230 13447166631 016321 0 ustar ligges users % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/xopen.R
\name{xopen.rcmdcheck}
\alias{xopen.rcmdcheck}
\title{Open the check directory in a file browser window}
\usage{
\method{xopen}{rcmdcheck}(target, app = NULL, quiet = FALSE, ...)
}
\arguments{
\item{target}{\code{rcmdcheck()} result.}
\item{app}{Specify the app to open \code{target} with, and its arguments,
in a character vector. Note that app names are platform dependent.}
\item{quiet}{Whether to echo the command to the screen, before
running it.}
\item{...}{Additional arguments, not used currently.}
}
\description{
Open the check directory in a file browser window
}
rcmdcheck/DESCRIPTION 0000644 0001762 0000144 00000002202 14124357312 013701 0 ustar ligges users Package: rcmdcheck
Title: Run 'R CMD check' from 'R' and Capture Results
Version: 1.4.0
Authors@R:
person(given = "Gábor",
family = "Csárdi",
role = c("cre", "aut"),
email = "csardi.gabor@gmail.com")
Description: Run 'R CMD check' from 'R' and capture the results
of the individual checks. Supports running checks in the background,
timeouts, pretty printing and comparing check results.
License: MIT + file LICENSE
URL: https://r-lib.github.io/rcmdcheck/,
https://github.com/r-Lib/rcmdcheck#readme
BugReports: https://github.com/r-Lib/rcmdcheck/issues
Imports: callr (>= 3.1.1.9000), cli (>= 3.0.0), curl, desc (>= 1.2.0),
digest, pkgbuild, prettyunits, R6, rprojroot, sessioninfo (>=
1.1.1), utils, withr, xopen
Suggests: covr, knitr, mockery, processx, ps, rmarkdown, svglite,
testthat, webfakes
Encoding: UTF-8
RoxygenNote: 7.1.2
Config/testthat/edition: 3
NeedsCompilation: no
Packaged: 2021-09-23 11:13:42 UTC; gaborcsardi
Author: Gábor Csárdi [cre, aut]
Maintainer: Gábor Csárdi Last updated on 2021-07-02 08:49:14 CEST.
Systems used for CRAN package checking.
| Flavor | R Version | OS Type | CPU Type | OS Info | CPU Info | Compilers | |
|---|---|---|---|---|---|---|---|
| r-devel-linux-x86_64-debian-clang | r-devel | Linux | x86_64 | Debian GNU/Linux testing | 2x 8-core Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz | clang version 12.0.1-+rc1-1~exp1; GNU Fortran (GCC) 10.2.1 (Debian 10.2.1-6) | |
| r-devel-linux-x86_64-debian-gcc | r-devel | Linux | x86_64 | Debian GNU/Linux testing | 2x 8-core Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz | GCC 10.2.1 (Debian 10.2.1-6) | |
| r-devel-linux-x86_64-fedora-clang | r-devel | Linux | x86_64 | Fedora 32 | 2x 6-core Intel Xeon E5-2440 0 @ 2.40GHz | clang version 12.0.0; GNU Fortran 10.2 | Details |
| r-devel-linux-x86_64-fedora-gcc | r-devel | Linux | x86_64 | Fedora 32 | 2x 6-core Intel Xeon E5-2440 0 @ 2.40GHz | GCC 10.3 | Details |
| r-devel-windows-x86_64 | r-devel | Windows | x86_64 | Windows Server 2008 (64-bit) | 2x Intel Xeon E5-2670 (8 core) @ 2.6GHz | GCC 8.3.0 (built by MSYS2, MinGW-W64 project) | |
| r-devel-windows-x86_64-gcc10-UCRT | r-devel | Windows | x86_64 | Windows Server 2016 (64-bit) | 2x Intel Xeon Gold 5118 (12 core) @ 2.3GHz | GCC 10.2.0 (built by MXE, MinGW-W64 project) | Details |
| r-patched-linux-x86_64 | r-patched | Linux | x86_64 | Debian GNU/Linux testing | 2x 8-core Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz | GCC 10.2.1 (Debian 10.2.1-6) | |
| r-patched-solaris-x86 | r-patched | Solaris | x86 | Solaris 10 | 8x Opteron 8218 (dual core) @ 2.6 GHz | Oracle Developer Studio 12.6 | Details |
| r-release-linux-x86_64 | r-release | Linux | x86_64 | Debian GNU/Linux testing | 2x 8-core Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz | GCC 10.2.1 (Debian 10.2.1-6) | |
| r-release-macos-arm64 | r-release | macOS | arm64 | macOS 11.2.1 (20D74) | Mac mini | Apple clang version 12.0.0 (clang-1200.0.32.29); GNU Fortran (GCC) 11.0.0 20201219 (experimental) | |
| r-release-macos-x86_64 | r-release | macOS | x86_64 | macOS 10.13.6 (17G11023) | Mac mini, 3 GHz | Apple LLVM version 10.0.0 (clang-1000.10.44.4); GNU Fortran (GCC) 8.2.0 | |
| r-release-windows-ix86+x86_64 | r-release | Windows | ix86+x86_64 | Windows Server 2008 (64-bit) | 2x Intel Xeon E5-2670 (8 core) @ 2.6GHz | GCC 8.3.0 (built by MSYS2, MinGW-W64 project) | |
| r-oldrel-macos-x86_64 | r-oldrel | macOS | x86_64 | macOS 10.13.6 (17G11023) | Mac mini, 3 GHz | Apple LLVM version 10.0.0 (clang-1000.10.44.4); GNU Fortran (GCC) 8.2.0 | |
| r-oldrel-windows-ix86+x86_64 | r-oldrel | Windows | ix86+x86_64 | Windows Server 2008 (64-bit) | 2x Intel Xeon E5-2670 (8 core) @ 2.6GHz | GCC 8.3.0 (built by MSYS2, MinGW-W64 project) |
['\"]?)", # quote if present "(?.*)", # value "\\g{q}", # the same quote again "\\s*", # trailing whitespace "$" # end of line ) parse_dot_line <- function(line) { match <- regexpr(line_regex, line, perl = TRUE) if (match == -1) { stop("Cannot parse check.env: ", substr(line, 1, 40), call. = FALSE) } as.list(extract_match(line, match)[c("key", "value")]) } extract_match <- function(line, match) { tmp <- mapply( attr(match, "capture.start"), attr(match, "capture.length"), FUN = function(start, length) { tmp <- substr(line, start, start + length - 1) } ) names(tmp) <- attr(match, "capture.names") tmp } rcmdcheck/R/compare.R 0000644 0001762 0000144 00000002417 14117731705 014161 0 ustar ligges users #' Compare a set of check results to another check result #' #' @param old A check result, or a list of check results. #' @param new A check result. #' @return An `rcmdcheck_comparison` object with fields: #' * `package`: the name of the package, string, #' * `versions`: package versions, length two character, #' * `status`: comparison status, see below, #' * `old`: list of `rcmdcheck` objects the old check(s), #' * `new`: `rcmdcheck` object, the new check, #' * `cmp`: #' #' #' @family check comparisons #' @export compare_checks <- function(old, new) { if (inherits(old, "rcmdcheck")) old <- list(old) rcmdcheck_comparison(old, new) } compare_check_files <- function(old, new) { old <- parse_check(old) new <- parse_check(new) rcmdcheck_comparison(list(old), new) } #' Compare a check result to CRAN check results #' #' @param check A check result. #' @param flavours CRAN check flavour(s) to use. By default all #' platforms are used. #' @return An `rmdcheck_comparison` object. #' #' @family check comparisons #' @export compare_to_cran <- function(check, flavours = cran_check_flavours(check$package)) { pkg <- check$package cran <- cran_check_results(pkg, flavours = flavours) compare_checks(old = cran, new = check) } rcmdcheck/R/session-info.R 0000644 0001762 0000144 00000001604 14123052257 015137 0 ustar ligges users make_fake_profile <- function(package, session_output, libdir) { profile <- tempfile() args <- list( `__output__` = session_output, `__package__` = package, `__libdir__` = libdir ) expr <- substitute({ local({ reg.finalizer( .GlobalEnv, function(...) { tryCatch({ .libPaths(c(`__libdir__`, .libPaths())) si <- sessioninfo::session_info(pkgs = `__package__`) saveRDS(si, `__output__`) }, error = function(e) NULL) }, onexit = TRUE ) Sys.unsetenv("R_TESTS") }) }, args) cat(deparse(expr), sep = "\n", file = profile) profile } get_session_info <- function(package, session_output) { ## Extract session info for this package session_info <- tryCatch( suppressWarnings(readRDS(session_output)), error = function(e) NULL ) session_info } rcmdcheck/R/api.R 0000644 0001762 0000144 00000003205 14120347676 013304 0 ustar ligges users #' Query R CMD check results and parameters #' #' @param check A check result. #' @return A named list with elements: #' * `package`: package name. #' * `version`: package version. #' * `rversion`: R version. #' * `notes`: character vector of check NOTEs, each NOTE is an #' element. #' * `warnings`: character vector of check WARNINGs, each WARNING is an #' element. #' * `errors`: character vector of check ERRORs, each ERROR is an element. #' A check timeout adds an ERROR to this vector. #' * `platform`: check platform #' * `checkdir`: check directory. #' * `install_out`: the output of the installation, contents of the #' `00install.out` file. A single string. #' * `description`: the contents of the DESCRIPTION file of the package. #' A single string. #' * `session_info`: the output of [sessioninfo::session_info()], #' from the R session performing the checks. #' * `checkdir`: the path to the check directory, if it hasn't been #' cleaned up yet, or `NA`. The check directory is automatically #' cleaned up, when the check object is deleted (garbage collected). #' * `cran`: whether it is a CRAN packaged package. #' * `bioc`: whether it is a BioConductor package. #' #' @export check_details <- function(check) { list( package = check$package, version = check$version, notes = check$notes, warnings = check$warnings, errors = check$errors, platform = check$platform, checkdir = check$checkdir, install_out = check$install_out, description = check$description, session_info = check$session_info, cran = check$cran, bioc = check$bioc ) } rcmdcheck/NEWS.md 0000644 0001762 0000144 00000011630 14123057145 013276 0 ustar ligges users # 1.4.0 * `cran_check_results()` now downloads results in parallel, so it is much faster. * `rcmdcheck_process` now redirects the standard error to the standard output, to make sure that they are correctly interleaved (#148). * rcmdcheck now puts Rtools on the PATH, via pkgbuild (#111). * rcmdcheck now builds the manual when building the package, if it is needed for `\Sexpr{}` expressions (#137). * This version fixes a rare race condition that made rcmdcheck fail (#139). * rcmdcheck now safeguards against R deleting the user's home directory via an `R CMD build` bug (#120). * rcmdcheck can now ignore files in `inst/doc` when building a package. See the `Config/build/clean-inst-doc` package option in `?"rcmdcheck-config"` (#130). * It is now possible to turn on/off ANSI colors for rcmdcheck only, without affecting the checked package. See `?"rcmdcheck-config" and the `RCMDCHECK_NUM_COLORS` environment variable and the `rcmdcheck.num_colors` option (#119, @jimhester). * `print.rcmdcheck()` now has a `test_output` argument and `rcmdcheck.test_output` global option, to control whether to print the full test output or not. (#121) * RStudio's Pandoc is now on the path during `rcmdcheck()` and `rcmdcheck_process` (#109, #132, @dpprdan). * `rcmdcheck()` now errors if the check process crashes (#110, #163). * `rcmdcheck()` prints the check ouptut better interactively, especially when the package has multiple test files (#145, #161). * rcmdcheck can now ignore `NOTE`s, if requested, see `?rcmdcheck` for details (#12, #160). * rcmdcheck now always converts its output to UTF-8 from the native encoding. It also handles parsing check output in a non-native encoding better (#152). * rcmdcheck now ignored time stamps when comparing two check results (#128). * rcmdcheck now does not print extra empty lines in the interactive output on GitHub Actions. * rcmdcheck now uses a more robust implementation to extract the session info from the check process (#164). # 1.3.3 * `cran_check_results()` has now a `quiet` argument, and the download progress bars are shown if it is set to `FALSE` (#17). * Fix output when standard output does not support `\r`, typically when it is not a terminal (#94). * Fix standard output and standard error mixup in the test cases, (#88, #96). * Fix parsing test failures when multiple architectures are checked, (#97). * `rcmdcheck()` has now better colors. WARNINGs are magenta, and NOTEs are blue (#103, @hadley). # 1.3.2 * `rcmdcheck()` now correctly overwrites existing tarballs if they already exist in the check directory. This time for real. # 1.3.1 * `rcmdcheck()` now correctly overwrites existing tarballs if they already exist in the check directory (#84 @jimhester). * rcmdcheck now uses `sessioninfo::session_info()` to query session information for the check. # 1.3.0 * New `rcmdcheck_process` class to run `R CMD check` in the background. * `rcmdcheck()` now supports timeouts (default is 10 minutes). * Checks now capture and print installation and test failures. * Checks now record and print the duration of the check. * Checks now record and print session information from the check session (#22). * `rcmdcheck()` new keep files until the returned check object is deleted, if check was run in a temporary directory (the default) (#23). * New `xopen()` to show the check file in a file browser window (#61). * Checks now save `install.out` and also `DESCRIPTION` in the result, and save the standard error and the exit status as well. * `rcmdcheck()` printing is now better: the message from the check that is actually _being performed_ is shown on the screen. * `rcmdcheck()` now shows a spinner while running check. * `rcmdcheck()` results now have a `summary()` method for check comparisons. * `rcmdcheck()` results now have a new `check_details()` method, to query the check results programmatically. (No need to use `$errors`, `$warnings`, etc. directly.) * Checks now find package root automatically (#18). * `rcmdcheck()` now has an `error_on` argument to throw an error on an `R CMD check` failure (#51). * `rcmdcheck()` result printing is now better, the colors are consistent (#54). # 1.2.1 * Compare two check results with `compare_checks` or compare check results to CRAN with `compare_to_cran`. * The result object has more metadata: package name, version, R version and platform. * Refined printing of the result. * `rcmdcheck()` works on tarballs build via `R CMD build` now. * Parse `R CMD check` results: `parse_check`, `parse_check_url`. * Download and parse check results for CRAN packages. * Report errors during the build, typically vignette errors. * Use the `callr` package (https://github.com/r-lib/callr) for running `R CMD` commands. # 1.1.0 * New arguments `libpath` and `repos` to set the library path and the default CRAN repository * Do not run tests on CRAN. # 1.0.0 First public release. rcmdcheck/MD5 0000644 0001762 0000144 00000015401 14124357312 012510 0 ustar ligges users f6ca683ef133cd384d406718018e88b1 *DESCRIPTION 51e9e0891b14449f167a1bcea3847206 *LICENSE f0927fd51ae473ef829406dd151acb78 *NAMESPACE 33c306091cc3597717b2c7a1a1510068 *NEWS.md 26d6f5a6a16a608264f93868b3fdb955 *R/api.R e3e7ba62568d70729146a90d14782012 *R/auto_clean.R 7f8a0a1ac8bb38fe32cbe4d0ab1be448 *R/background.R 61a712fe32bcc1016dbedfba219b0d84 *R/build.R a38c608c5156e5e8ee5308d2c767b7d9 *R/callback.R f83ee6f0a20afed2dfa00afa3d3853fa *R/compare.R b5542f2837d2cb2f799186fdf10a9469 *R/comparison-summary.R ca1b8a6e0cbd6e5daf2564b69c58c67a *R/comparison.R 14f0c1fdf13bf710a1ed3f981def68a6 *R/cran.R 9a7df9dd7d63a0c5f006f4893b26f8e9 *R/env.R 99add9f69aeb2e4ee154b6cf40759233 *R/error.R 6ec78296dbe35a3ef5335e24a7a59f36 *R/http.R bdd98daa9b1a391290f8fe87aaf037f2 *R/options.R 2c212fd1d446a01d2ef690947694dc42 *R/package.R 83a3202957c2e5642ca5c5651bb49bf8 *R/parse.R 0f62b5a8ad86ed4075d312bbab80ad8a *R/print.R 44726f220f6dbc3da9470bb4ff539ca9 *R/session-info.R 1c4788812d60f6c6a76660cdc9f76780 *R/styles.R 3a658440a93f66c2e5c7509b42dc1e60 *R/utils.R 1dbb429e25ec17084cfc3d3fddae8e9a *R/xopen.R 06b16976c557cb1f3441da2114b25626 *README.md f9aebe5b12f3be05bbe69a2e886322a3 *man/check_details.Rd c1feeb425b7669da69692c91f5eddf22 *man/compare_checks.Rd 5cf17dfa9fdd1e539f53a06f05fd6650 *man/compare_to_cran.Rd 032f6b0c8b86eb8cf1a4a9ec2139ddb3 *man/cran_check_flavours.Rd d077f1bb40f464ad85fa5e645834b6ce *man/cran_check_results.Rd 75ece5b94f138c8563306db9cafd3caf *man/data_frame.Rd d353258f0850feea650de5e6f7942d9a *man/myrep.Rd c814643ae18379ff2b3e741629f3009a *man/parse_check.Rd e0debcb268e343a4230229dfd616c8a3 *man/parse_check_url.Rd ff86f3954ef94486c952dbd68b17cac6 *man/print.rcmdcheck.Rd 0c6ab79d6908a89f67a4ef9df7ae04c7 *man/print.rcmdcheck_comparison.Rd f54fc08f3e02ac8c279894c8a098a4ea *man/rcmdcheck-config.Rd 5952cfcbf35ef5668ffabcbb5fd0bc2b *man/rcmdcheck.Rd 74710a0cde1f56897e85f398f9a6952e *man/rcmdcheck_process.Rd fb9540d69c07a494642d660741509a3a *man/xopen.rcmdcheck.Rd 2539d24ffc8ea7e94ea08df088e31ad9 *tests/testthat.R ac50aafdeaf88103d295627a083ea63a *tests/testthat/REDCapR-fail.log da2300b56ec5144c7dc6347e6553345e *tests/testthat/REDCapR-ok.log 3302decba9f20f8c32833b8843b80800 *tests/testthat/RSQLServer-install/00check.log c3a48909f4f308edd658a9b765d5f912 *tests/testthat/RSQLServer-install/00install.out f0c327c900f057a573f927c4dbabc09d *tests/testthat/_snaps/callback.md 69216f4988043aa0a31c122c45bb165b *tests/testthat/_snaps/comparison.md d405667f8669e1e2c71f5ade70cb834c *tests/testthat/_snaps/parse.md 21159c1a0e758f33d854c1c4a544d15f *tests/testthat/_snaps/utils.md 91943fa6c447053b812cb086c81bbc14 *tests/testthat/bad1/DESCRIPTION 82f1b9c0f341ed20b3df56f668e4e0ec *tests/testthat/bad1/NAMESPACE b0e9d02fe1d9680c0e23c88f7c8b3a30 *tests/testthat/bad1/R/package.R a387cec3225581d4ac4d784663343d0c *tests/testthat/bad1/man/foobar2.Rd ec08c12c262073d689682c731b723898 *tests/testthat/bad1/tests/testthat.R 2143596857c29fecb66929cb8a030360 *tests/testthat/bad1/tests/testthat/test-bad.R cdeeef6c26b41007692a4f6535137ac2 *tests/testthat/bad1/tools/check.env c92f1e87367ca60cef2cd8404d9cd5a6 *tests/testthat/bad1/vignettes/test.Rmd 1b9e4f3f5a54c4abfa8a376f3ad8560e *tests/testthat/bad2/DESCRIPTION 386a9453b5f25bdc3086b03fbc9b60a3 *tests/testthat/bad2/NAMESPACE aa975e44511c795eb7f217ea7eddbe1e *tests/testthat/bad2/R/package.R fbccb380f15b67427c2c87816bbb0de2 *tests/testthat/bad3/DESCRIPTION 82f1b9c0f341ed20b3df56f668e4e0ec *tests/testthat/bad3/NAMESPACE 2fda064a2a1b221b7950d7f37fd5d6bc *tests/testthat/bad3/R/package.R a387cec3225581d4ac4d784663343d0c *tests/testthat/bad3/man/foobar2.Rd ec08c12c262073d689682c731b723898 *tests/testthat/bad3/tests/testthat.R 77b37c1bd61df642168cd1d412509c6f *tests/testthat/bad3/tests/testthat/test-bad.R c92f1e87367ca60cef2cd8404d9cd5a6 *tests/testthat/bad3/vignettes/test.Rmd fbccb380f15b67427c2c87816bbb0de2 *tests/testthat/bad4/DESCRIPTION 82f1b9c0f341ed20b3df56f668e4e0ec *tests/testthat/bad4/NAMESPACE 56edef25da05adbf2a0513ad1bb240b2 *tests/testthat/bad4/R/package.R a387cec3225581d4ac4d784663343d0c *tests/testthat/bad4/man/foobar2.Rd 8ccff755ebaa14110458784c666a8c5d *tests/testthat/bikedata-ok.log 953f7dcb43b00558f4147898c835022d *tests/testthat/dataonderivatives-test/00check.log d94f93baf7fca49b08423c936b28c178 *tests/testthat/dataonderivatives-test/00install.out 12b794693fcd743b9c144e1016fe226a *tests/testthat/dataonderivatives-test/tests/testthat.Rout.fail 62326416d70206fbbc72c67f9abee5fe *tests/testthat/fixtures/bad-tests.tar.gz fef910f8d90e17ec29909c848e3f53bc *tests/testthat/fixtures/badenc.fail b8555e4f8c73e0c5031b056bf8258f5d *tests/testthat/fixtures/badpackage_1.0.0.tar.gz 692779a59097a2ee29258ab9fa27975b *tests/testthat/fixtures/checks/check_flavors.html da1031bb2a573f7fdd8c18844c478750 *tests/testthat/fixtures/checks/comparing.txt 8fcdb98d2459eb525a30a5573ac1bd85 *tests/testthat/fixtures/checks/comparing2.txt 15ef446dbaa566de69f9e47ec6436dee *tests/testthat/fixtures/checks/r-devel-linux-x86_64-debian-clang/rcmdcheck-00check.txt 10ff31f28166c52d15813e05d22a715a *tests/testthat/fixtures/checks/r-devel-linux-x86_64-debian-gcc/rcmdcheck-00check.txt ed364dd9a58b1ee8bde4da35e85f05c3 *tests/testthat/fixtures/checks/r-release-windows-ix86+x86_64/rcmdcheck-00check.txt 9b427f91537c371b322197499e50a0a8 *tests/testthat/fixtures/checks/test-error.txt fe47e0a5876277dac0a9afdd8dd05d51 *tests/testthat/fixtures/iso8859-15.rds 08bccb1cacf0536c4b0d81b7c0d15c58 *tests/testthat/fixtures/run1.rds b19dd00e5ef5ae587b18d81b2de13d93 *tests/testthat/fixtures/test-error.txt 2f6d45c596f6a7d991391b4454d5f2a2 *tests/testthat/fixtures/tests-as-cran.txt 7d29b820189c4f75fe052db682b1a228 *tests/testthat/fixtures/tests-not-as-cran.txt a07c41cd32c9f968ef7a4ee61e19515a *tests/testthat/fixtures/win.rds 5503cbaa190b62cce0eda8ce563bcbf1 *tests/testthat/helpers.R 84e7a8b20194ff3a390b3aa24c023990 *tests/testthat/minimal-ee.log fcd7f77cac7157a494b44b584bf000e8 *tests/testthat/minimal-ewn.log 0fb2d99463eb17315b0d138011314519 *tests/testthat/minimal-ok.log 0c831b7d8d5acee9ce2406ab22ed020c *tests/testthat/test-auto_clean.R 13d5fbf64b47eb8675da88592c03152a *tests/testthat/test-build.R 7045610fc23e0b963bfd2a79c8d49425 *tests/testthat/test-callback.R 02c62fd30ff60a4f05aba7dc07b81deb *tests/testthat/test-color.R 7b6adc42014ba86a91ad1024a498d77c *tests/testthat/test-comparison.R 16124fa949811d8715003b46e8e54238 *tests/testthat/test-cran.R 09282325aaf4debade48fc0a2de4a72d *tests/testthat/test-crash.R 9023f295721558fdb21d9891a156c7b4 *tests/testthat/test-env.R 2e3ebfe3f6accab5764b8d7f704882b9 *tests/testthat/test-errors.R cc499fdcd5ded4dbcac7e46069757e7b *tests/testthat/test-http.R ffc9e15543840318d5c48b9ba7994257 *tests/testthat/test-parse.R 8bc264a9137212bd221457d7f12a5a62 *tests/testthat/test-rcmdcheck.R 3e43ae0da83b5898e92622e9caae7364 *tests/testthat/test-tests.R 14ab5d0f4b68a321d071c4542006ab8b *tests/testthat/test-utils.R