-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
86 lines (72 loc) · 2.39 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
---
title: checked
output: github_document
always_allow_html: yes
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{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
<!-- badges: start -->
[![R-CMD-check](https://github.com/Genentech/checked/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Genentech/checked/actions/workflows/R-CMD-check.yaml/badge.svg)
[![CRAN](https://img.shields.io/cran/v/checked.svg)](https://cran.r-project.org/package=checked)
[![coverage](https://codecov.io/gh/Genentech/checked/branch/main/graph/badge.svg)](https://app.codecov.io/gh/Genentech/checked/tree/main)
<!-- badges: end -->
```{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()
```