/
README.Rmd
196 lines (150 loc) · 8.92 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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
---
output: github_document
---
```{r, echo = FALSE, message=FALSE, warning=FALSE}
library("airtabler")
library("purrr")
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# rOpenSci Software Peer Review
<!-- README.md is generated from README.Rmd. Please edit that file -->
Thank you for considering submitting your package to the rOpenSci suite. All
the packages contributed by community members go through a process of [open peer review](https://ropensci.org/blog/2017/09/01/nf-softwarereview/) to ensure a consistent level of quality for our users. This process also allows us to ensure that your package meets our guidelines and provides opportunity for discussion where exceptions are requested.
This README is a short intro to Software Peer Review for you as a potential author or reviewer. For more information, consult our [gitbook "rOpenSci Packages: Development, Maintenance, and Peer Review"](https://devguide.ropensci.org/).
**Our [code of conduct](https://ropensci.org/code-of-conduct/) is mandatory for everyone involved in our review process.**
* [Why and how submit your package to rOpenSci?](#why-submit)
* [Why and how review for rOpenSci?](#why-review)
* [Further resources](#further)
* [Editors and reviewers](#editors)
# <a href="#why-submit" name="why-submit"></a>Why and how submit your package to rOpenSci?
- First, and foremost, we hope you submit your package for review **because you
value the feedback**. We aim to provide useful feedback to package authors
and for our review process to be open, non-adversarial, and focused on
improving software quality.
- Once aboard, your package will continue to receive **support from rOpenSci
members**. You'll retain ownership and control of your package, but we
can help with ongoing maintenance issues such as those associated with
updates to R and dependencies and CRAN policies.
- rOpenSci will **promote your package** through our [webpage](https://ropensci.org/packages/), [blog](https://ropensci.org/blog/), and [social media](https://twitter.com/ropensci). Packages in our suite also get a [documentation website that is automatically built and deployed after each push](https://devguide.ropensci.org/building.html#docsropensci).
- rOpenSci **packages can be cross-listed** with other repositories such as CRAN
and BioConductor.
- rOpenSci packages that contain a short accompanying paper can, after review,
be automatically submitted to the
[Journal of Open-Source Software](http://joss.theoj.org/) for fast-tracked
publication.
If you want to submit a package, read our [guide for authors](https://devguide.ropensci.org/authors-guide.html) before opening a submission issue in this repository.
## <a href="#why-review" name="why-review"></a>Why and how to review packages for rOpenSci?
- As in any peer-review process, we hope you choose to review **to give back
to the rOpenSci and scientific communities.** Our mission to expand
access to scientific data and promote a culture of reproducible research
is only possible through the volunteer efforts of community members like you.
- Review is a two-way conversation. By reviewing packages, you'll have the
chance to **continue to learn development practices from authors and
other reviewers**.
- The open nature of our review process allows you to **network and meet
colleagues and collaborators** through the review process. Our community
is friendly and filled with supportive members expert in R development and
many other areas of science and scientific computing.
To volunteer to be one of our reviewers, please fill out this [short form](https://ropensci.org/software-reviewer/) providing your contact information and areas or expertise. We are always looking for more reviewers with both general package-writing experience and domain expertise in the fields packages are used for.
Please also read [our guide for reviewers](https://devguide.ropensci.org/reviewerguide.html).
## <a href="#further" name="further"></a>Further resources
Our [gitbook "rOpenSci Packages: Development, Maintenance, and Peer Review"](https://devguide.ropensci.org/) also includes:
* [a guide for editors](https://devguide.ropensci.org/editorguide.html)
* [our policies](https://devguide.ropensci.org/policies.html)
* chapters dedicating to good practice for package maintenance
* different templates: [review template](https://devguide.ropensci.org/reviewtemplate.html), [editor's template](https://devguide.ropensci.org/editortemplate.html), [review request template](https://devguide.ropensci.org/reviewrequesttemplate.html).
Our review process is always in development, and we encourage feedback and discussion
on how to improve the process on our [forum](https://discuss.ropensci.org/) and in the [ropensci/software-review-meta issue tracker](https://github.com/ropensci/software-review-meta/issues).
# <a href="#editors" name="editors"></a> Editors and reviewers
rOpenSci's Software Peer Review process is run by our team of dedicated editors and reviewers.
Information on the current team, and the current status of software peer review, can be seen on our [interactive dashboard](https://ropensci-review-tools.github.io/dashboard/).
```{r get-airtable-data, warning=FALSE, echo=FALSE}
if (Sys.getenv("AIRTABLE_API_KEY") == ""){
Sys.setenv(AIRTABLE_API_KEY = params$AIRTABLE_API_KEY)
}
if (Sys.getenv("AIRTABLE_ID") == ""){
Sys.setenv(AIRTABLE_ID = params$AIRTABLE_ID)
}
at_eic <- airtabler::airtable(base = Sys.getenv("AIRTABLE_ID"),
table = "editor-in-chief-rotation")
eic <- at_eic$`editor-in-chief-rotation`$select_all()
at_rev <- airtabler::airtable(base = Sys.getenv("AIRTABLE_ID"),
table = "reviewers-prod")
reviewers <- at_rev$`reviewers-prod`$select_all()
at_guest <- airtabler::airtable(base = "app8dssb6a7PG6Vwj",
table = "guest-editors")
guest_editors <- at_guest$`guest-editors`$select_all()
```
### Editor-in-Chief
```{r eic, echo=FALSE, results='asis'}
eic$period_start <- as.Date(eic$period_start)
eic$period_end <- as.Date(eic$period_end)
today <- Sys.Date ()
eic_now <- eic [which (eic$period_start <= today & eic$period_end >= today), ]
eic_name <- eic_now$acting_eic_name [[1]]
eic_id <- eic_now$acting_eic
eic_in_rev_table <- which(reviewers$id == eic_id)
eic_github <- reviewers$github[eic_in_rev_table]
out <- paste0(
"We rotate our Editor-in-Chief, generally every three months. ",
"Our current Editor-in-Chief is [", eic_name, "](https://github.com/",
eic_github, ").\n"
)
cat(out, sep = "")
```
### Editorial team
```{r editors, echo=FALSE}
editor_index_all <- purrr::map_lgl(reviewers$editor, ~!is.null(.))
editors_all <- reviewers[which(editor_index_all), c("name", "github", "Affiliation", "editor")]
editors_all <- editors_all [which(!editors_all$name == eic_name), ]
last_names <- humaniformat::last_name(trimws(editors_all$name))
editors_all <- editors_all[order(last_names), ]
editors_past <- editors_all[grep("Emeritus", editors_all$editor), ]
editors <- editors_all[which(!editors_all$name %in% editors_past$name), ]
```
Our current team of editors for software peer-review includes:
```{r gen_ed_out-fn, echo=FALSE}
gen_ed_out <- function(ed_dat) {
if (!"Affiliation" %in% names(ed_dat)) {
ed_dat$Affiliation <- NA_character_
}
out <- gsub("(,\\sNA|\\s);", ";", paste0(
"- [", ed_dat$name, "](https://github.com/", ed_dat$github, "), ",
ed_dat$Affiliation, ";\n"))
out[length(out)] <- gsub(";\\n$", ".\n", out[length(out)])
return(out)
}
```
```{r editors-out, echo=FALSE, results='asis'}
cat(gen_ed_out(editors), sep = "")
```
### Reviewers and former editors
We are grateful to the following individuals who have offered up their time and expertise to review packages submitted to rOpenSci.
```{r reviewers, echo=FALSE, results='asis'}
reviewers <- reviewers[purrr::map_lgl(reviewers$reviews,
~!is.null(.)) &
!(reviewers$name %in% c(editors_all$name, "???")), ]
# get last names
last_names <- humaniformat::last_name(trimws(reviewers$name))
reviewers <- reviewers[order(last_names), ]
reviewers$name[is.na(reviewers$name)] <- reviewers$github[is.na(reviewers$name)]
cat(paste0("[", reviewers$name, "](https://github.com/", reviewers$github, ")", collapse = " \U00B7 "))
```
We are also grateful to the following individuals who have previously served as editors.
```{r editors_past, echo=FALSE, results='asis'}
cat(gen_ed_out(editors_past), sep = "")
```
And the following who have served as guest editors.
```{r guest-editors-out, echo=FALSE, results='asis'}
guest_editors <- guest_editors[!(guest_editors$name %in%
c(editors_all$name, eic_name, "???")), ]
# get last names
last_names <- humaniformat::last_name(trimws(guest_editors$name))
guest_editors <- guest_editors[order(last_names), ]
cat(gen_ed_out(guest_editors), sep = "")
```