Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Genentech/checked
batch R CMD check management
https://github.com/Genentech/checked
checks r revdeps
Last synced: 9 days ago
JSON representation
batch R CMD check management
- Host: GitHub
- URL: https://github.com/Genentech/checked
- Owner: Genentech
- License: other
- Created: 2024-07-09T19:27:46.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T21:34:45.000Z (3 months ago)
- Last Synced: 2024-09-17T02:47:16.669Z (3 months ago)
- Topics: checks, r, revdeps
- Language: R
- Homepage: https://genentech.github.io/checked/
- Size: 1.49 MB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - Genentech/checked - batch R CMD check management (R)
README
---
title: checked
output: github_document
always_allow_html: yes
---
```{r, include = FALSE, cache = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README",
out.width = "100%",
asciicast_theme = if (Sys.getenv("IN_PKGDOWN") == "true") {
"pkgdown"
} else {
"readme"
}
)
asciicast::init_knitr_engine(
startup = bquote({
options(repos = .(getOption("repos")))
}),
echo_input = FALSE
)
```
> Batch `R CMD check` management
[](https://github.com/Genentech/checked/actions/workflows/R-CMD-check.yaml/badge.svg)
[](https://cran.r-project.org/package=checked)
[](https://app.codecov.io/gh/Genentech/checked/tree/main)
```{sh clone-dev-praise, echo = FALSE, results = "hide"}
# praise chosen for having few direct and reverse dependencies
rm -rf /tmp/praise
git clone https://github.com/gaborcsardi/praise /tmp/praise
```
# Running Checks
Although `checked` is broadly capable of running arbitrary sets of `R CMD check`
tasks, reverse dependency checking is one of the most common use cases where
batch `R CMD check`s are needed.
Running reverse dependency checks is as easy as
```r
library(checked)
x <- run("/home/dev/praise")
results(x)
```
```{r, echo = FALSE}
library(checked)
x <- run("/tmp/praise", reporter = NULL)
results(x)
```
## Monitoring Runs
Because running many checks in parallel can be a difficult process to monitor,
capable interfaces will provide a convenient output for tracking various
runs, check results and package installations; keeping a log of any issues
that might arise during the process.
If your editor doesn't support the full output, you might consider launching
your checks in a terminal which should be less constrained. This would also
free up your preferred editor for you to use while your checks run.
```r
library(checked)
run("/home/dev/praise")
```
```{asciicast ansi-tty-example, cache = FALSE}
#| asciicast_knitr_output = "svg",
#| asciicast_at = "all",
#| asciicast_cursor = FALSE,
#| asciicast_speed = 2
options(checked.tty_tick_interval = 200)
checked::run("/tmp/praise")
cat()
```