-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
162 lines (131 loc) · 6.12 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
---
title: "roreviewapi"
output:
md_document:
variant: gfm
rmarkdown::html_vignette:
self_contained: no
---
# roreviewapi
<!-- badges: start -->
[![R build status](https://github.com/ropensci-review-tools/roreviewapi/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci-review-tools/roreviewapi/actions?query=workflow%3AR-CMD-check)
[![Project Status: Concept](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
<!-- badges: end -->
Plumber API to generate reports on package structure and function for the
[`@ropensci-review-bot`](https://github.com/ropensci-review-bot). The package
is not intended for general use, and these documents are primarily intended for
maintainers of this package, although they may serve as useful templates for
similar endeavours. Please contact us if you have any questions.
Uses functionality provided by the
[`pkgcheck`](https://github.com/ropensci-review-tools/pkgcheck) and
[`pkgstats`](https://github.com/ropensci-review-tools/pkgstats) packages. This suite of
three packages requires a few system installs, two for
[`pkgstats`](https://github.com/ropensci-review-tools/pkgstats) of
[`ctags`](https://ctags.io) and [GNU
`global`](https://www.gnu.org/software/global/). Procedures to install these
libraries on various operating systems are described in the [`pkgstats`
package](https://docs.ropensci.org/pkgstats). This package itself also requires
both the [GitHub command-line-interface (cli), `gh`](https://cli.github.com/)
and [`dos2unix`](https://sourceforge.net/projects/dos2unix/).
A local GitHub token also needs to be stored as an environment
variable named `GITHUB_TOKEN`, and not `GITHUB_PAT` or anything else; the `gh`
cli only recognises the former name.
The package also works by locally caching previously analysed packages, in
a `pkgcheck` subdirectory of the location determined by
```{r, rappdirs, eval = FALSE}
rappdirs::user_cache_dir ()
```
You may manually erase the contents of this subdirectory at any time at no
risk.
## Dockerfile
The server associated with this package can be built by cloning this
repository, and modifying the associated
[`Dockerfile`](https://github.com/ropensci-review-tools/roreviewapi/blob/master/Dockerfile)
by inserting a GitHub token, and associated `git config` options.
## Code of Conduct
Please note that this package is released with a [Contributor Code of
Conduct](https://ropensci.org/code-of-conduct/). By contributing to this
project, you agree to abide by its terms.
## Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropenscilabs/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
### Code
<table>
<tr>
<td align="center">
<a href="https://github.com/mpadge">
<img src="https://avatars.githubusercontent.com/u/6697851?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/commits?author=mpadge">mpadge</a>
</td>
<td align="center">
<a href="https://github.com/maelle">
<img src="https://avatars.githubusercontent.com/u/8360597?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/commits?author=maelle">maelle</a>
</td>
<td align="center">
<a href="https://github.com/sckott">
<img src="https://avatars.githubusercontent.com/u/577668?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/commits?author=sckott">sckott</a>
</td>
</tr>
</table>
### Issue Authors
<table>
<tr>
<td align="center">
<a href="https://github.com/xuanxu">
<img src="https://avatars.githubusercontent.com/u/6528?u=415877b00c554982144cb6708028656e8c9ec8e2&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/issues?q=is%3Aissue+author%3Axuanxu">xuanxu</a>
</td>
</tr>
</table>
### Issue Contributors
<table>
<tr>
<td align="center">
<a href="https://github.com/gaborcsardi">
<img src="https://avatars.githubusercontent.com/u/660288?u=677db9b09ed7b9ca76a2fc24622a9ca433ce05d5&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/issues?q=is%3Aissue+commenter%3Agaborcsardi">gaborcsardi</a>
</td>
<td align="center">
<a href="https://github.com/ropensci-review-bot">
<img src="https://avatars.githubusercontent.com/u/77673839?u=f26c3eb2a3b6c74a7f100d4a707116d24d723d81&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/issues?q=is%3Aissue+commenter%3Aropensci-review-bot">ropensci-review-bot</a>
</td>
<td align="center">
<a href="https://github.com/wlandau">
<img src="https://avatars.githubusercontent.com/u/1580860?u=6ed1edc717e0853259312206ae59a3aa81fe3bbc&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/issues?q=is%3Aissue+commenter%3Awlandau">wlandau</a>
</td>
<td align="center">
<a href="https://github.com/wlandau-lilly">
<img src="https://avatars.githubusercontent.com/u/22958003?u=588673163e201f2f908ba75190a2d88d3971fa9e&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/issues?q=is%3Aissue+commenter%3Awlandau-lilly">wlandau-lilly</a>
</td>
<td align="center">
<a href="https://github.com/adamhsparks">
<img src="https://avatars.githubusercontent.com/u/3195906?u=bcbaa54476d9576fe2fdc9c7deff9204413f567b&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/issues?q=is%3Aissue+commenter%3Aadamhsparks">adamhsparks</a>
</td>
<td align="center">
<a href="https://github.com/s3alfisc">
<img src="https://avatars.githubusercontent.com/u/19531450?u=26be80705a31079d973246c98bf3b26d9131e7d3&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/ropensci-review-tools/roreviewapi/issues?q=is%3Aissue+commenter%3As3alfisc">s3alfisc</a>
</td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->