Thanking Your Reviewers: Gratitude through Semantic Metadata
At rOpenSci, our R package peer review process relies on the the hard work of many volunteer reviewers. These community members donate their time and expertise to improving the quality of rOpenSci packages and helping drive best practices into scientific software.
Our open review process, where reviews and reviewers are public, means that one benefit for reviewers is that they can get credit for their reviews. We want reviewers to see as much benefit as possible, and for their contributions to be recorded as part of the intellectual trail of academic work, so we have been working at making reviews visible and discoverable.
That is why we are very excited about a tiny change in yesterday’s release of R 3.4.4.
If your are running R 3.4.3, and type
utils:::MARC_relator_db_codes_used_with_R into the console, you get this:
> utils:::MARC_relator_db_codes_used_with_R  "aut" "com" "ctr" "ctb" "cph" "cre" "dtc" "fnd" "ths" "trl"
Under 3.4.4, you get this:
> utils:::MARC_relator_db_codes_used_with_R  "aut" "com" "ctr" "ctb" "cph" "cre" "dtc" "fnd" "rev" "ths" "trl"
What’s that little
"rev" that shows up, third from right? It’s the official inclusion of “Reviewer” as an R package author role! 🎉
These three-letter codes come from the MARC (Machine-Readable Cataloging) terms vocabulary, a standard set of authorship types originally created for some of the first computerized library systems. R uses these codes to distinguish between different types of package authors. You may be familiar with some of these terms that show up in
DESCRIPTION files, like so:
[email protected]: person("Scott", "Chamberlain", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1444-9135"))
cre stand for “Author” and “Creator”, indicating that Scott is the original and major creator of a package. You may have also seen
ctb (Contributor) or
cph (Copyright Holder1).
Standard descriptors like this are important because they allow for information about authorship to be machine-readable and credit for authors’ work to be cataloged and transferred. When metadata about R packages is displayed in help files or on websites, it’s clear the role everyone has played. Such metadata is also critical to transitive credit, the important task of tracking contributions through chains of dependencies so as to provide recognition to software developers and data providers that the traditional citation system often misses.
While there are many more2 MARC relator terms, R only allows the a small set that make sense in the context of software packages. These are found in
utils:::MARC_relator_db_codes_used_with_R. Codes outside this set this set won’t pass R CMD Check and are not allowed on CRAN.
We believe peer reviewers make an imporant contribution the quality of published software. That’s why last year we requested R-Core add
"rev" (Reviewer), to the list of allowed contributor types. And Lo and Behold, Kurt Hornik made the change on our behalf 3. It is now in the release version of R.
Since CRAN uses the development version of R to check and build packages, the option has actually been available on CRAN for a while. A trickle of authors have been already been awknowledging peer-reviewers in this way by in their package DESCRIPTION files.
We hope to see adoption of reviewer acknowledgements in software metadata beyond rOpenSci. It can be adopted by authors who submit to JSS, JOSS, or any journal or process where reviewers make significant comments on software code or documentation. For non-R software, we’re working on including reviewers in codemeta, a cross-language software metadata standard.
A few notes about how this development relates specifically to rOpenSci’s peer-review process:
First, it is 100% the choice of package authors to decide whether reviewers made a sufficient contribution to be included in
Authorsin this way. While we promote this option in general, we’ll never ask an author to specifically include a reviewer. Like a manuscript’s acknowledgements section, the
Authorsection is under developer control. It is also up to reviewers whether they want to be included, so package authors should ask reviewers first.
Second, rOpenSci editors should not be listed under
"edt"(Editor) is not a valid R authorship role, and we are a step too far removed to be included. But we are flattered by those who have asked.
Finally, if you do include reviewers in this way, we think it’s best practice to include information linking back to the review, like so:
person("Bea", "Hernández", role = "rev", comment = "Bea reviewed the package for rOpenSci, see https://github.com/ropensci/onsoftware-reviewssues/116")
We are very excited about this development and how it can improve incentives for peer review. Thanks to R-core for getting aboard with this, and the early adopters who tested it!
c( person("Noam", "Ross", role = c("aut", "cre", "lbt")), person("Maëlle", "Salmon", role = c("rev", "med"), comment = "Comments to improve structure of the introduction") person("Karthik", "Ram", role = c("rev", "elt"), comment = "Fixed a small typo"), person("Scott", "Chamberlain", role = c("rev", "sce"), comment = "Agrees with Maëlle about the intro.") )
- I can’t get through this post without mentioning that Her Majesty the Queen in Right of Canada, as represented by the Minister of Natural Resources Canada, is
cphon eight CRAN packages. 👑 ↩
- Found here or as a handy data frame with descriptions in
- R-core also added
"fnd"(Funder) in R 3.4.3. ↩