Chapter 8 Guide for Editors
Software Peer Review at rOpenSci is managed by a team of editors. We are piloting a system of a rotating Editor-in-Chief (EiC).
If you’re a guest editor, thanks for helping! Please contact the editor who invited you to handle a submission for any question you might have.
8.1 EiC Responsibilities
The EiC serves for 3 months or a time agreed to by all members of the editorial board. The EiC plays the following roles
- Watches all issues posted to the software-review repo.
- Assigns package submissions to other editors, including self, to handle. Mostly this just rotates among editors, unless the EiC thinks an editor is particularly suited to a package, or an editor rejects due to being too busy or because of conflicting interests.
- Raises scope/overlap issue with all editors if they see an ambiguous case. This may also be done by handling editors (see below). To initiate discussion, this is posted to the rOpenSci Slack software review channel, tagging all editors.
- Responds to pre-submission inquiries and
metaissues posted to the software-review and software-review-meta repos, similarly pinging channel if discussion is needed. Any editor should feel free to step in on these. See this section about how to respond to out-of-scope (pre-) submissions.
- Responds to referrals from JOSS or other publication partners.
- Monitors pace of review process and reminds other editors to move packages along as needed.
8.2 Handling Editor’s Checklist
8.2.1 Upon submission:
- Tag issue with
1/editor-checkstag and assign a main editor. Please strive to finish the checks and start looking for reviewers within 5 working days.
- Use the editor template to guide initial checks and record your response to the submission. You can also streamline your editor checks by using the
pkgreviewrpackage created by associate editor Anna Krystalli
- Check that template has been properly filled out.
- Check against policies for fit and overlap. Initiate discussion via Slack #software-review channel if needed for edge cases that haven’t been caught by previous checks by the EiC. If reject, see this section about how to respond.
- Check that mandatory parts of template are complete. If not, direct authors toward appropriate instructions.
- Run automated tests:
goodpractice::gp()(most exceptions will need to be justified by the author in the particular context of their package.),
NOT_CRANif needed, as well. Check that documentation is generated using
roxygen2, not by hand (this isn’t part of automatic tests yet). Report relevant outputs in the issue thread.
- For packages needing continuous integration on multiple platforms (cf criteria in this section of the CI chapter) make sure the package gets tested on multiple platforms (having the package built on both Travis and AppVeyor for instance).
- Wherever possible when asking for changes, direct authors to automatic tools such as
styler, and to online resources (sections of this guide, sections of the R packages book) to make your feedback easier to use. Example of editor’s checks.
- If initial checks show major gaps, request changes before assigning reviewers.
- If the package raises a new issue for rOpenSci policy, start a conversation in Slack or open a discussion on the rOpenSci forum to discuss it with other editors (example of policy discussion).
8.2.2 Look for and assign reviewers:
- Switch numbered tag to
- Ask author to add a rOpenSci review badge to their README, via
rodev::use_review_badge(<issue_number>). Badge URL is
https://badges.ropensci.org/<issue_id>_status.svg. Full link should be:
- Use the email template if needed for inviting reviewers
- When inviting reviewers, include something like “if I don’t hear from you in a week, I’ll assume you are unable to review,” so as to give a clear deadline when you’ll move on to looking for someone else.
- Assign a due date 3 weeks after all reviewers have been found.
- Once two or more reviewers are found, assign reviewers by tagging in the issue with the following format:
Reviewer: @githubname1 Reviewer: @githubname2 Due date: YYYY-MM-DD
- Switch numbered tag
to 3/reviewers-assignedonce reviewers are assigned.
- Invite authors and reviewers to rOpenSci Slack if they aren’t on this Slack already.
- Update Airtable database: Add one of the review record numbers associated with the package to the
Reviewsfield of each reviewer’s record. Insert new
Reviewersrecord if required.
220.127.116.11 How to look for reviewers
18.104.22.168.1 Where to look for reviewers?
As a (guest) editor, use
- the potential suggestions made by the submitter(s), (although submitters may have a narrow view of the types of expertise needed. We suggest not using more than one of suggested reviewers)
- the Airtable database of reviewers and volunteers
- and the authors of rOpenSci packages.
When these sources of information are not enough, * ping other editors in Slack for ideas, * look for users of the package or of the data source/upstream service the package connects to (via their opening issues in the repository, starring it, citing it in papers, talking about it on Twitter). * You can also search for authors of related packages on r-pkg.org. * R-Ladies has a directory specifying skills and interests of people listed.
22.214.171.124 Criteria for choosing a reviewer
Here are criteria to keep in mind when choosing a reviewer. You might need to piece this information together by searching CRAN and the potential reviewer’s GitHub page and general online presence (personal website, Twitter).
- Has not reviewed a package for us within the last 6 months.
- Some package development experience.
- Some domain experience in the field of the package or data source
- No conflicts of interest.
- Try to balance your sense of the potential reviewer’s experience against the complexity of the package.
- Diversity - with two reviewers both shouldn’t be cis white males.
- Some evidence that they are interested in openness or R community activities, although blind emailing is fine.
Each submission should be reviewed by two package reviewers. Although it is fine for one of them to have less package development experience and more domain knowledge, the review should not be split in two. Both reviewers need to review the package comprehensively, though from their particular perspective. In general, at least one reviewer should have prior reviewing experience, and of course inviting one new reviewer expands our pool of reviewers.
8.2.3 During review:
- Check in with reviewers and authors occasionally. Offer clarification and help as needed.
- In general aim for 3 weeks for review, 2 weeks for subsequent changes, and 1 week for reviewer approval of changes.
- Upon all reviews being submitted, change the review status tag to
4/review-in-awaiting-changesto update the reminder bot.
- Update Airtable database: Add the link to the review comment to the
review_urlfield and the number of review hours to the
review_hoursfield of each review record.
- If the author stops responding, refer to the policies and/or ping the other editors in the Slack channel for discussion. Importantly, if a reviewer was assigned to a closed issue, contact them when closing the issue to explain the decision, thank them once again for their work, and make a note in our database to assign them to a submission with high chances of smooth software review next time (e.g. a package author who has already submitted packages to us).
- Upon changes being made, change the review status tag to
8.2.4 After review:
- Change the status tag to
- You can use the comment template.
- Add review/er information to the review database.
- If authors intend to submit to CRAN, direct them to the section about CRAN gotchas and offer to provide support through this process.
- Ask authors to add a mention of the review in
- Ask authors to migrate to
- Create a two-person team in rOpenSci’s “ropensci” GitHub organization, named for the package, with yourself and the package author as members.
- Have the author transfer the repository to
- Go to the repository settings in rOpenSci’s “ropensci” GitHub organization and give the author “Admin” access to the repository.
- Ask author to:
- Add rOpenSci footer to README
- Add a CodeMeta file by running
- Change any needed links, such those for CI badges
- Re-activate CI services
- For Travis, activating the project in the ropensci account should be sufficient
- For AppVeyor, tell the author to update the GitHub link in their badge, but do not transfer the project: AppVeyor projects should remain under the authors’ account. The badge is
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/ropensci/pkgname?branch=master&svg=true)](https://ci.appveyor.com/project/individualaccount/pkgname).
- For Codecov, the webhook may need to be reset by the author.
- Add rOpenSci footer to README
- Nominate a package to be featured in an rOpenSci blog post or tech note if you think it might be of high interest. Please note in the software review issue one or two things the author could highlight, and tag
- Add a “peer-reviewed” topic to the repo.
- Close the software-review issue.
8.2.5 For joint JOSS submissions:
- After repo is transferred to ropensci and admin rights assigned, have author generate a new release with a DOI.
- Ask author to submit package via https://joss.theoj.org/papers/new
Watch for paper to pop up at https://joss.theoj.org/papers, then add the following comment to the submission thread:
This submission has been accepted to rOpenSci. The review thread can be found at [LINK TO SOFTWARE REVIEW ISSUE]
8.2.6 Package promotion:
8.3 Responding to out-of-scope submissions
Thank authors for their submission, explain the reasons for the decision, and direct them to other publication venues if relevant, and to the rOpenSci discussion forum. Use wording from Aims and scope in particular regarding the evolution of scope over time, and the overlap and differences between unconf/staff/software-review development.