https://github.com/ropensci-org/pkgreviewr
R package to facilitate rOpenSci package reviews.
https://github.com/ropensci-org/pkgreviewr
r r-package review ropensci ropensci-reviews rstats unconf unconf18
Last synced: 5 months ago
JSON representation
R package to facilitate rOpenSci package reviews.
- Host: GitHub
- URL: https://github.com/ropensci-org/pkgreviewr
- Owner: ropensci-org
- License: other
- Created: 2018-01-20T18:36:43.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T12:27:12.000Z (7 months ago)
- Last Synced: 2025-04-26T07:55:03.669Z (5 months ago)
- Topics: r, r-package, review, ropensci, ropensci-reviews, rstats, unconf, unconf18
- Language: HTML
- Homepage: https://docs.ropensci.org/pkgreviewr/
- Size: 2.4 MB
- Stars: 36
- Watchers: 4
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - ropensci-org/pkgreviewr - R package to facilitate rOpenSci package reviews. (HTML)
README
# pkgreviewr
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://github.com/ropensci-org/pkgreviewr/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/ropensci-org/pkgreviewr)
# pkgreviewr
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](articles/get_started.html) vignette for more
details
## Installation
You can install `pkgreviewr` from R-universe with:
``` r
install.packages("pkgreviewr", repos = c("https://ropensci.r-universe.dev", "https://cloud.r-project.org"))
```
Or from GitHub with:
``` r
# install.packages("pak")
pak::pak("ropensci-org/pkgreviewr")
```
### Git and GitHub setup
`pkgreviewr` functions clone the source code of the package under review
so require **Git** to be installed. It also interacts with GitHub to get
data from the software-review repository and to prepopulate review
project files.
Therefore, to ensure it will work well, please run
[`usethis::git_sitrep()`](https://usethis.r-lib.org/reference/git_sitrep.html).
### R Notebooks
The package currently also makes use of
[**`R Notebooks`**](https://rmarkdown.rstudio.com/r_notebooks.html) (an
RMarkdown format) and requires installation of **Rstudio version 1.0**
or higher, but we are [considering offering an option to remove the
requirement for
RStudio](https://github.com/ropenscilabs/pkgreviewr/issues/64).
------------------------------------------------------------------------
## Review workflow
#### 1. Create and initialise review project
``` r
library(pkgreviewr)
review_parent <- withr::local_tempdir() # not a temp dir in real life :-)
pkgreview_create(
pkg_repo = "ropensci/rdflib",
review_parent = review_parent
)
#> ✔ Setting `fork = FALSE`.
#> ✔ Creating '/tmp/RtmpxDZe8i/filebd7173b99561/rdflib/'.
#> ✔ Cloning repo from "git@github.com:ropensci/rdflib.git" into
#> '/tmp/RtmpxDZe8i/filebd7173b99561/rdflib'.
#> ✔ Setting active project to "/tmp/RtmpxDZe8i/filebd7173b99561/rdflib".
#> ℹ Default branch is "master".
#> ✔ Setting active project to "".
#> ✔ review project "rdflib-review" initialised
```
The review project directory will contain all the files you’ll need to
complete the review and will be initialised with git.
``` r
fs::dir_ls(review_parent)
#> /tmp/RtmpxDZe8i/filebd7173b99561/rdflib
#> /tmp/RtmpxDZe8i/filebd7173b99561/rdflib-review
fs::dir_tree(fs::path(review_parent, "rdflib-review"))
#> /tmp/RtmpxDZe8i/filebd7173b99561/rdflib-review
#> ├── R
#> ├── README.md
#> ├── index.Rmd
#> └── review.md
```
#### 2. Perform review
Open `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`](https://github.com/ropensci/software-review/issues)
issue by copying and pasting the completed `pkgreview.md` template.
#### 4. Publish review\*
OPTIONAL: Publish your review on GitHub. See
[vignette](articles/publish-review-on-github.html) for further
instructions
------------------------------------------------------------------------
## `pkgreviewr` for editors
`pkgreviewr` can now also be used to set up projects for editor checks.
See [`pkgreviewr` for editors](articles/editors.html) vignette.
------------------------------------------------------------------------
Please note that ‘pkgreviewr’ is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree
to abide by its terms.