{"Package":"rcmdcheck","Title":"Run 'R CMD check' from 'R' and Capture Results","Version":"1.4.0","Authors@R":"\nperson(given = \"Gbor\",\nfamily = \"Csrdi\",\nrole = c(\"cre\", \"aut\"),\nemail = \"csardi.gabor@gmail.com\")","Description":"Run 'R CMD check' from 'R' and capture the results\nof the individual checks. Supports running checks in the background,\ntimeouts, pretty printing and comparing check results.","License":"MIT + file LICENSE","URL":"https://r-lib.github.io/rcmdcheck/,\nhttps://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),\ndigest, pkgbuild, prettyunits, R6, rprojroot, sessioninfo (>=\n1.1.1), utils, withr, xopen","Suggests":"covr, knitr, mockery, processx, ps, rmarkdown, svglite,\ntestthat, webfakes","Encoding":"UTF-8","RoxygenNote":"7.1.2","Config/testthat/edition":"3","NeedsCompilation":"no","Packaged":"2021-09-23 11:13:42 UTC; gaborcsardi","Author":"Gbor Csrdi [cre, aut]","Maintainer":"Gbor Csrdi ","Repository":"CRAN","Date/Publication":"2021-09-27 15:10:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/rcmdcheck_1.4.0.tar.gz","jsonAuthors":[{"name":"Gbor Csrdi","email":"csardi.gabor@gmail.com","maintainer":true}],"readme":"Run R CMD check from R and Capture Results\n================\n\n - [rcmdcheck](#rcmdcheck)\n - [Installation](#installation)\n - [Usage](#usage)\n - [License](#license)\n\n\n\n# rcmdcheck\n\n> Run R CMD check from R and Capture Results\n\n\n\n[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html)\n[![R build\nstatus](https://github.com/r-lib/rcmdcheck/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/rcmdcheck/actions)\n[![](https://www.r-pkg.org/badges/version/rcmdcheck)](https://www.r-pkg.org/pkg/rcmdcheck)\n[![CRAN RStudio mirror\ndownloads](https://cranlogs.r-pkg.org/badges/rcmdcheck)](https://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\ninstall.packages(\"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 failure.\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: 12.4s\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\" \"errors\" \n#> [6] \"platform\" \"checkdir\" \"install_out\" \"description\" \"session_info\"\n#> [11] \"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\" \"r-devel-linux-x86_64-debian-gcc\" \n#> [3] \"r-devel-linux-x86_64-fedora-clang\" \"r-devel-linux-x86_64-fedora-gcc\" \n#> [5] \"r-devel-windows-x86_64\" \"r-patched-linux-x86_64\" \n#> [7] \"r-patched-solaris-x86\" \"r-release-linux-x86_64\" \n#> [9] \"r-release-macos-arm64\" \"r-release-macos-x86_64\" \n#> [11] \"r-release-windows-ix86+x86_64\" \"r-oldrel-macos-x86_64\" \n#> [13] \"r-oldrel-windows-ix86+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.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking top-level files ... WARNING\n#> Output from running autoreconf:\n#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:71: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:71: the top level\n#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:110: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:110: the top level\n#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:127: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:127: the top level\n#> \n#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔\n#> \n#> $`r-devel-linux-x86_64-debian-gcc`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking top-level files ... WARNING\n#> Output from running autoreconf:\n#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:71: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:71: the top level\n#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:110: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:110: the top level\n#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:127: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:127: the top level\n#> \n#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔\n#> \n#> $`r-devel-linux-x86_64-fedora-clang`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 16.9Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 14.0Mb\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.6 ────\n#> Duration: 0ms\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 0 notes ✔\n#> \n#> $`r-devel-windows-x86_64`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 9.8Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 6.9Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-devel-windows-x86_64-gcc10-UCRT`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking whether package 'igraph' can be installed ... ERROR\n#> See below...\n#> \n#> ❯ checking package dependencies ... NOTE\n#> Package suggested but not available for checking: 'rgl'\n#> \n#> ── Install failure ───────────────────────────────────────────────────────────────────────────────────────────────────────\n#> \n#> <00install.out file does not exist>\n#> 1 error ✖ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-patched-linux-x86_64`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking top-level files ... WARNING\n#> Output from running autoreconf:\n#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:71: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:71: the top level\n#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:110: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:110: the top level\n#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:127: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:127: the top level\n#> \n#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔\n#> \n#> $`r-patched-solaris-x86`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\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.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking top-level files ... WARNING\n#> Output from running autoreconf:\n#> configure.ac:71: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:71: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:71: the top level\n#> configure.ac:110: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:110: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:110: the top level\n#> configure.ac:127: warning: The macro `AC_HELP_STRING' is obsolete.\n#> configure.ac:127: You should run autoupdate.\n#> ./lib/autoconf/general.m4:204: AC_HELP_STRING is expanded from...\n#> configure.ac:127: the top level\n#> \n#> 0 errors ✔ | 1 warning ✖ | 0 notes ✔\n#> \n#> $`r-release-macos-arm64`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 23.7Mb\n#> sub-directories of 1Mb or more:\n#> R 2.0Mb\n#> help 1.1Mb\n#> libs 20.0Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-release-macos-x86_64`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 21.2Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 18.3Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-release-windows-ix86+x86_64`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 17.1Mb\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#> $`r-oldrel-macos-x86_64`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 21.2Mb\n#> sub-directories of 1Mb or more:\n#> R 1.4Mb\n#> help 1.1Mb\n#> libs 18.3Mb\n#> \n#> 0 errors ✔ | 0 warnings ✔ | 1 note ✖\n#> \n#> $`r-oldrel-windows-ix86+x86_64`\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────────────── igraph 1.2.6 ────\n#> Duration: 0ms\n#> \n#> ❯ checking installed package size ... NOTE\n#> installed size is 17.1Mb\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.3.9000 ────\n#> Status: OK\n#> \n#> ── Fixed\n#> \n#> ✔ checking LazyData ... NOTE\n#> ✔ checking LazyData ... NOTE\n#> ✔ checking LazyData ... NOTE\n#> ✔ checking LazyData ... NOTE\n#> ✔ checking LazyData ... NOTE\n#> ✔ checking LazyData ... NOTE\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 82576.\n```\n\n``` r\nchkpx$wait()\nchkpx$parse_results()\n#> ── R CMD check results ───────────────────────────────────────────────────────────────────────── rcmdcheck 1.3.3.9000 ────\n#> Duration: 23.6s\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.4.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-09-27T17:30:34+0000"}}

Description

Usage

Arguments