The goal of pkgreviewr is to facilitate rOpenSci reviewers in their package reviews.
It creates a review project containing populated templates of all the files you'll need to complete your review. It also clones the source code of the package under review to a convenient location, allowing easy checking and testing.
See Getting started vignette for more details
You can install
pkgreviewr from GitHub with:
# install.packages("devtools") devtools::install_github("ropenscilabs/pkgreviewr")
Because rOpenSci reviews are conducted through github repository
pkgreviewr uses your GitHub
user.email when creating new review projects. If you do not have both settings in your global configuration, you will receive an error.
You see if user name and email are currently configured with
# install.packages("usethis") usethis::use_git_config()
You can set both using:
usethis::use_git_config( user.name = "Jane", user.email = "firstname.lastname@example.org")
Alternatively, from within your terminal,
check you current git configuration with:
git config --global --list
and set it with
git config --global user.name "Jane" git config --global user.email "email@example.com"
The package also makes use of
R Notebooks (an RMarkdown format) and requires installation of Rstudio version 1.0 or higher
1. Create and initialise review project
library(pkgreviewr) pkgreview_create(pkg_repo = "ropensci/rdflib", review_parent = "~/Documents/workflows/rOpenSci/reviews/")
The review project directory will contain all the files you'll need to complete the review and will be initialised with git.
rdflib-review ├── README.md ├── index.Rmd ├── pkgreview.md └── rdflib-review.Rproj
2. Perform review
index.Rmd and work through the review in the notebook. You can make notes either in
index.Rmd or directly in the
pkgreview.md response template.
3. Submit review
Submit your review in the package
ropensci/software-review issue by copying and pasting the completed
4. Publish review*
OPTIONAL: Publish your review on GitHub. See vignette for further instructions
pkgreviewr for editors
pkgreviewr can now also be used to set up projects for editor checks. See
pkgreviewr for editors vignette.
Please note that 'pkgreviewr' is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.