-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathREADME.Rmd
113 lines (69 loc) · 3.59 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# pkgreviewr
<!-- badges: start -->
[](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)
<!-- badges: end -->
# 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
<br>
#### 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
)
```
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)
fs::dir_tree(fs::path(review_parent, "rdflib-review"))
```
#### 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.
<br>
#### 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.
<br>
#### 4. Publish review*
OPTIONAL: Publish your review on GitHub. See [vignette](articles/publish-review-on-github.html) for further instructions
<br>
***
## `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.