{"Package":"rcmdcheck","Title":"Run 'R CMD check' from 'R' and Capture Results","Version":"1.3.3","Author":"Gbor Csrdi","Maintainer":"Gbor Csrdi ","Description":"Run 'R CMD check' from 'R' and capture the\nresults of the individual checks. Supports running checks in the\nbackground, timeouts, pretty printing and comparing check results.","License":"MIT + file LICENSE","LazyData":"true","URL":"https://github.com/r-Lib/rcmdcheck#readme","BugReports":"https://github.com/r-Lib/rcmdcheck/issues","RoxygenNote":"6.1.1","Suggests":"covr, knitr, mockery, rmarkdown, testthat","Imports":"callr (>= 3.1.1.9000), cli (>= 1.1.0), crayon, desc (>=\n1.2.0), digest, pkgbuild, prettyunits, R6, rprojroot,\nsessioninfo (>= 1.1.1), utils, withr, xopen","Encoding":"UTF-8","NeedsCompilation":"no","Packaged":"2019-05-07 11:39:19 UTC; gaborcsardi","Repository":"CRAN","Date/Publication":"2019-05-07 12:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/rcmdcheck_1.3.3.tar.gz","readme":"Run R CMD check from R and Capture Results\n================\n\n\n\n# rcmdcheck\n\n> Run R CMD check from R and Capture\nResults\n\n\n\n[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://tidyverse.org/lifecycle/#maturing)\n[![Linux Build\nStatus](https://travis-ci.org/r-lib/rcmdcheck.svg?branch=master)](https://travis-ci.org/r-lib/rcmdcheck)\n[![Windows Build\nstatus](https://ci.appveyor.com/api/projects/status/github/r-lib/rcmdcheck?svg=true)](https://ci.appveyor.com/project/gaborcsardi/rcmdcheck)\n[![](http://www.r-pkg.org/badges/version/rcmdcheck)](http://www.r-pkg.org/pkg/rcmdcheck)\n[![CRAN RStudio mirror\ndownloads](http://cranlogs.r-pkg.org/badges/rcmdcheck)](http://www.r-pkg.org/pkg/rcmdcheck)\n[![Coverage\nStatus](https://img.shields.io/codecov/c/github/r-lib/rcmdcheck/master.svg)](https://codecov.io/github/r-lib/rcmdcheck?branch=master)\n\n\nRun R CMD check form R programatically, and capture the results of the\nindividual checks.\n\n## Installation\n\n``` r\nsource(\"https://install-github.me/r-lib/rcmdcheck\")\n```\n\n## Usage\n\n``` r\nlibrary(rcmdcheck)\nrcmdcheck(\"path/to/R/package\")\n```\n\nCall `rcmdcheck()` on a source R package `.tar.gz` file, or on a folder\ncontaining your R package. Supply `quiet = FALSE` if you want to omit\nthe output. The result of the check is returned, in a list with elements\n`errors`, `warnings`, and `notes`. Each element is a character vector,\nand one element of the character vectors is a single\nfailure.\n\n

\n\n### Programmatic usage\n\n`rcmdcheck()` returns an `rcmdcheck` object, which you can query and\nmanipulate.\n\n``` r\nlibrary(rcmdcheck)\nchk <- rcmdcheck(\"tests/testthat/bad1\", quiet = TRUE)\nchk\n#> ── R CMD check results ────────────────────────────── badpackage 1.0.0 ────\n#> Duration: 11.6s\n#> \n#> ❯ checking DESCRIPTION meta-information ... WARNING\n#> Non-standard license specification:\n#> Public domain\n#> Standardizable: FALSE\n#> \n#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔\n```\n\n`check_details()` turns the check results into a simple lists with the\nfollowing information currently:\n\n``` r\nnames(check_details(chk))\n#> [1] \"package\" \"version\" \"notes\" \"warnings\" \n#> [5] \"errors\" \"platform\" \"checkdir\" \"install_out\" \n#> [9] \"description\" \"session_info\" \"cran\" \"bioc\"\n```\n\n - `package`: Package name.\n - `version`: Package version number.\n - `notes`: Character vector of check `NOTE`s.\n - `warnings`: Character vector of check `WARNING`s.\n - `errors`: Character vector of check `ERROR`s.\n - `platform`: Platform, e.g. `x86_64-apple-darwin15.6.0`.\n - `checkdir`: Check directory.\n - `install_out`: Output of the package installation.\n - `description`: The text of the `DESCRIPTION` file.\n - `session_info`: A `sessioninfo::session_info` object, session\n information from within the check process.\n - `cran`: Flag, whether this is a CRAN package. (Based on the\n `Repository` field in `DESCRIPTION`, which is typically only set for\n published CRAN packages.)\n - `bioc`: Flag, whether this is a Bioconductor package, based on the\n presence of the `biocViews` field in `DESCRIPTION`.\n\nNote that if the check results were parsed from a file, some of these\nfields might be missing (`NULL`), as we don’t have access to the\noriginal `DESCRIPTION`, the installation output, etc.\n\n### Parsing check output\n\n`parse_check()` parses check output from a file, `parse_check_url()`\nparses check output from a URL.\n\n### CRAN checks\n\nrcmdcheck has a functions to access CRAN’s package check results.\n\n`cran_check_flavours()` downloads the names of the CRAN platforms:\n\n``` r\ncran_check_flavours()\n#> [1] \"r-devel-linux-x86_64-debian-clang\"\n#> [2] \"r-devel-linux-x86_64-debian-gcc\" \n#> [3] \"r-devel-linux-x86_64-fedora-clang\"\n#> [4] \"r-devel-linux-x86_64-fedora-gcc\" \n#> [5] \"r-patched-linux-x86_64\" \n#> [6] \"r-patched-solaris-x86\" \n#> [7] \"r-release-linux-x86_64\" \n#> [8] \"r-release-windows-ix86+x86_64\" \n#> [9] \"r-release-osx-x86_64\" \n#> [10] \"r-oldrel-windows-ix86+x86_64\" \n#> [11] \"r-oldrel-osx-x86_64\"\n```\n\n`cran_check_results()` loads and parses all check results for a package.\n\n``` r\ncran_check_results(\"igraph\")\n#> $`r-devel-linux-x86_64-debian-clang`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔\n#> \n#> $`r-devel-linux-x86_64-debian-gcc`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔\n#> \n#> $`r-devel-linux-x86_64-fedora-clang`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 16.1Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 13.1Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-devel-linux-x86_64-fedora-gcc`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔\n#> \n#> $`r-patched-linux-x86_64`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔\n#> \n#> $`r-patched-solaris-x86`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 9.6Mb\n#> sub-directories of 1Mb or more:\n#> R 1.5Mb\n#> help 1.2Mb\n#> libs 6.5Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-release-linux-x86_64`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔\n#> \n#> $`r-release-windows-ix86+x86_64`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> ❯ checking whether package 'igraph' can be installed ... NOTE\n#> See below...\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 16.7Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 13.8Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 2 notes ✖\n#> \n#> $`r-release-osx-x86_64`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> ❯ checking package dependencies ... NOTE\n#> Package suggested but not available for checking: ‘graph’\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 17.9Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.2Mb\n#> libs 14.9Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 2 notes ✖\n#> \n#> $`r-oldrel-windows-ix86+x86_64`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 16.7Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 13.8Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-oldrel-osx-x86_64`\n#> ── R CMD check results ──────────────────────────────── igraph 1.2.4.1 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 17.2Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 14.2Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> attr(,\"package\")\n#> [1] \"igraph\"\n#> attr(,\"class\")\n#> [1] \"rmcdcheck_cran_results\"\n```\n\n### Comparing checks\n\n`compare_checks()` can compare two or more `rcmdcheck` objects.\n`compare_to_cran()` compares an `rcmdcheck` object to the CRAN checks of\nthe same package:\n\n``` r\nchk <- rcmdcheck(quiet = TRUE)\ncompare_to_cran(chk)\n#> ─ R CMD check comparison rcmdcheck 1.3.3 / 1.3.2 / 1.3.2 / 1.3.2 / 1.\n#> Status: OK\n#> \n#> ── Fixed\n#> \n#> ✔ checking tests ... [41s] ERROR\n#> ✔ checking tests ... [38s] ERROR\n```\n\n### Background processes\n\n`rcmdcheck_process` is a `processx::process` class, that can run `R CMD\ncheck` in the background. You can also use this to run multiple checks\nconcurrently. `processx::process` methods can be used to poll or\nmanipulate the check processes.\n\n``` r\nchkpx <- rcmdcheck_process$new()\nchkpx\n#> PROCESS 'R', running, pid 90876.\n```\n\n``` r\nchkpx$wait()\nchkpx$parse_results()\n#> ── R CMD check results ─────────────────────────────── rcmdcheck 1.3.3 ────\n#> Duration: 14.8s\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔\n```\n\n## License\n\nMIT © Mango Solutions, Gábor Csárdi, RStudio","jobInfo":{"package":"rcmdcheck","version":"1.3.3","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-09-27T17:30:08+0000"}}

Description

Usage

Arguments