This repository has been archived by the owner on Sep 9, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
121 lines (88 loc) · 4.77 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
cchecks
=======
```{r echo=FALSE}
knitr::opts_chunk$set(
warning = FALSE,
message = FALSE,
collapse = TRUE,
comment = "#>"
)
```
[](https://github.com/ropensci/cchecks/actions/)
[](https://codecov.io/github/ropensci/cchecks?branch=master)
R client for the CRAN checks API at <https://cranchecks.info>
[CRAN checks API docs][docs]
authentication is only needed for the CRAN checks API for the functions that start with `cchn`
See https://docs.ropensci.org/cchecks for full documentation on `cchecks`
## Install
```{r eval=FALSE}
remotes::install_github("ropensci/cchecks")
```
```{r}
library("cchecks")
```
## heartbeat
- `cch_heartbeat()`
## packages
- current day package check data: `cch_pkgs()` or `cch_pkgs("packagename")`
- historical package check data (30 days back): `cch_pkgs_history()`
- historical package check data for all packages by day: `cch_history()`
- search historical data: `cch_pkgs_search()`
There's an important shortcoming of historical data. The links in the historical
data in the `checks` field are not date specific. If you go to a link in historical
data, for example for April 2nd, 2020, links in that set of data link to whatever
the current check data is for that package. The `check_details` field is
date specific though; the text is scraped from the package checks page each day
and stored, so you can count on that to be date specific. There are sometimes
links to further checks, often of compiled packages on various types of checks
that CRAN runs; we do not have those check results - we could get them but
have not take the time to sort that out.
## maintainers
- all maintainers: `cch_maintainers()`
- maintainers by email: `cch_maintainers("maelle.salmon_at_yahoo.se")`
## notifications
Functions for working with notifications are all prefixed with `cchn`.
`cchn` functions are designed to be used from within an R package directory. The functions
look for the package name and maintainer email address. Functions copy heavily from
https://github.com/r-hub/rhub
The functions
- `cchn_register()`: registration
- `cchn_pkg_rule_list()`/`cchn_rule_list()`: list your own rules
- `cchn_pkg_rule_get()`/`cchn_rule_get()`: get a rule by id
- `cchn_pkg_rule_add()`/`cchn_rule_add()`: create a rule
- `cchn_pkg_rule_delete()`/`cchn_rule_delete()`: delete a rule by id (get id from `cchn_pkg_rule_list`/`cchn_rule_list`)
Functions prefixed with `cchn_pkg_` operate within a package
directory. That is, your current working directory is an R
package, and is the package for which you want to handle CRAN checks
notifications. These functions make sure that you are inside of
an R package, and use the email address and package name based
on the directory you're in.
Functions prefixed with just `cchn_` do not operate within a package.
These functions do not guess package name at all, but require the user
to supply a package name (for those functions that require a package name);
and instead of guessing an email address from your package, we guess email
from the cached cchecks email file (see `?cchn_register`).
The first thing to do is to register an email address. In an R session in a working directory for
one of your packages that is on CRAN, run `cchn_register()`. This function:
- registers your email address
- a validation email is sent to you right away with your token
- paste the token from the amil into the R session
- the email and token are then saved in a file on your machine
- all `cchn_rule*` functions use this cached token
- you don't need to pass the token in any `cchn` function calls
If you run `cchn_register()` in the same package directory (with the same email address),
you'll be issued a new token, which will be updated in your cached token file.
It's entirely possible to have more than one email address you use across different R packages.
If you run `cchn_register()` in a different package directory (with a different email address
from a previous run of `cchn_register()`), you'll be issued a different token associated
with that new email address.
See `?cchn_rules` for details on how the rules work and many examples of adding rules.
Note that you can only manage your own rules. You can not list, get, or delete rules
of other users.
## Meta
* Please [report any issues or bugs](https://github.com/ropensci/cchecks/issues).
* License: MIT
* Get citation information for `cchecks` in R doing `citation(package = 'cchecks')`
* Please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.
[docs]: https://cranchecks.info/docs
[coc]: https://github.com/ropensci/cchecks/blob/master/CODE_OF_CONDUCT.md