ropensci-org / pkgreviewr Goto Github PK

View Code? Open in Web Editor NEW

38.0 5.0 8.0 2.01 MB

R package to facilitate rOpenSci package reviews.

Home Page: https://docs.ropensci.org/pkgreviewr/

License: Other

R 2.15% Shell 0.04% HTML 97.81%

unconf18 r r-package rstats review ropensci-reviews ropensci unconf

pkgreviewr's Introduction

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 vignette for more details

Installation

You can install pkgreviewr from GitHub with:

# install.packages("remotes")
remotes::install_github("ropensci-org/pkgreviewr")

Git

pkgreviewr functions clone the source code of the package under review so require Git to be installed.

GitHub user configuration

Because rOpenSci reviews are conducted through github repository ropensci/software-review, pkgreviewr uses your GitHub username to prepopulate various fields in the review project files.

To detect your username correctly, a PAT, Personal Authorisation Token, needs to be set up. You can use usethis::create_github_token() to generate a PAT and usethis::edit_r_environ() to store it as environment variable GITHUB_PAT or GITHUB_TOKEN in your .Renviron file. For more info, see article on publishing review on GitHub in pkgreviewr documentation.

If you do not have a PAT set up, you will receive an warning and any fields related to your GitHub username will not be correctly populated. However, this shouldn't affect your ability to complete your review.

R Notebooks

The package currently also makes use of R Notebooks (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.

Review workflow

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

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 issue by copying and pasting the completed pkgreview.md template.

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.

pkgreviewr's People

Contributors

Stargazers

Watchers

Forkers

noamross maurolepore omaymas ltierney kylehamilton nevrome rekyt haozeke

pkgreviewr's Issues

create a pkgdown website?

and move parts of the details from the README in a vignette?

(just a suggestion obviously)

Fix pkgdown configuration for articles

Error in data_articles_index(pkg) : Vignettes missing from index: editors

Write function to extract repo metadata using github API V4

Resources

API docs
- repo metadata
tidyverse repository dashboard
- In particular these template queries
Maelle's post

README comments

Just add that it's to facilitate the work of reviewers? I know it's sort of implied by saying "reviews" but later when there are tools to facilitate the work of authors and editors (I'll probably implement these in separate packages), there could be some confusion?

Deal with package under review having no Rproj

Sometimes the package under review will have the Rproj in the repo, sometimes not.

The URL docs.ropensci.org/pkgreviewr fails 404 (nothing found)

I see this link in the devguide and in the section "about" of the package repository. I see a functional URL at https://ropensci-org.github.io/pkgreviewr/.

Error using pkgreviewr::pkgreview_create() - review.md not found

Hi! I was trying to create the template for reviewing using pkgreviewr::pkgreview_create(), and got an error. The version of the package that is installed is the most recent from GitHub.

The error was: URL not found: https://api.github.com/repos/ropensci/software-review/contents/.buffy/templates/review.md
Seems like the function is trying to access the file .buffy/templates/review.md from this repo: https://github.com/ropensci/software-review/tree/master/.buffy/templates . But there is no such file there.

Looking at the commit history, seems like the file review.md was deleted 12 days ago: ropensci/software-review@228346b#diff-d680c2407256f0bfc1312efc544ac2fa3a7f97d2fbb242a89043b8b664b1c54b

This file is meant to stay deleted?

Full message:

> pkgreviewr::pkgreview_create(pkg_repo = "frictionlessdata/frictionless-r", 
+                              review_parent = ".")
cloning into '/var/folders/z5/nh0wlcsj2fq99rjrj1x7hcwc0000gn/T/Rtmp6Mz0ma/pkgreviewr_prep/frictionless-r'...
Receiving objects:   1% (42/4135),   48 kb
Receiving objects:  11% (455/4135),  472 kb
Receiving objects:  21% (869/4135),  536 kb
Receiving objects:  31% (1282/4135),  601 kb
Receiving objects:  41% (1696/4135),  649 kb
Receiving objects:  51% (2109/4135),  689 kb
Receiving objects:  61% (2523/4135),  729 kb
Receiving objects:  71% (2936/4135),  776 kb
Receiving objects:  81% (3350/4135),  816 kb
Receiving objects:  91% (3763/4135),  888 kb
Receiving objects: 100% (4135/4135), 1072 kb, done.
✔ Package source cloned successfully
✔ pkg_dir written out successfully
Error in gh_process_response(raw) : 
GitHub API error (404): 
Message: Not Found
Read more at https://docs.github.com/rest/reference/repos#get-repository-content

URL not found: https://api.github.com/repos/ropensci/software-review/contents/.buffy/templates/review.md
Type .Last.error.trace to see where the error occurred

email address?

Does the package really use the user's email address? I don't think so?

In the README it could be advised to either do the git settings your recommend, or to set the GITHUB_USERNAME environment variable (that'll still be needed if the email address isn't public on GitHub anyway), or maybe it's just easier to refer to whoami docs?

usethis::use_github

usethis::use_github could replace step 3 of the review workflow

Not able to create a project on Windows

cf r-lib/whoami#4

Add tests for editor templates

Address in relation #56

Package review workflow info

http://andeekaplan.com/presentations/ropensci/comm_call_2017_09_13.html#1

adding `spelling` to Suggests

Great package.
You may consider adding the spelling package to the Suggests section.
It's required in order to knitr the index.Rmd file. Now for some reason it is not being installed automatically so it breaks the knitting of index.Rmd file in the package review folder.

pkgreview_create vs pkgreview_init

As said earlier, fantastic package and initiative!

I have trouble understanding why pkgreview_create and pkgreview_init are two separate functions?

your repo lacks a description

😉

Use tic for deploying the pkgdown website?

tic is a package developed in ropenscilabs by @krlmlr &co that I've started using for our dev_guide deployment.

One thing it allows is deploying the pkgdown website in docs/ from Travis so one doesn't need to remember to build the website when updating the docs and vignettes. There's an example repo https://github.com/krlmlr/tic.package

From what I can tell one would need to

Prepare deployment using the travis::use_travis_deploy function (it creates and add keys to the repo &Travis project)
Modify .travis.yml, .Rbuildignore, and add a tic.R

I'm happy to help!

Dependency on RStudio

I am 100% ok with this package depending on RStudio.

That said I'm looking at workflowr and it says "Note that while you do not need to use RStudio with workflowr, do not delete the Rproj file because it is required by other functions.". I'm not sure if it means that it can work without RStudio installed?

And in any case a warning in the docs might be useful (and potentially one in the code? can one run a function to know whether RStudio is installed? rstudioapi::isAvailable() only says whether it's running).

In workflowr code they also check the RStudio version installed.

This issue is not urgent at all but I preferred writing down what I saw in their code before I forgot about it.

check that review_parent exists sooner

The validity of the path should be checked sooner I think. I've just used the function with a wrong folder 🤦‍♀️

what happens if there's no review badge yet?

(for editor checks)

Missing GH parameters will not load index.Rmd, README.md

Issue

If GitHub global configs user.name and user.email are not set then pkgreview_init will not generate the index.Rmd and README.md file as specified in the README.

pkgreview_init()

Setting the parameters and running pkgreview_init() again does not resolve the issue. When asked if I wish to over-write the existing project and selectin "Yes" (or a variation thereof),

Error in fallback_or_stop(fallback, "Cannot find GitHub username for email") :
Cannot find GitHub username for email

Reprex

Using Docker and rocker/tidyverse:3.4.3,

From terminal:

git config --global user.name "Mona Lisa"

Within RStudio:

devtools::install_github("ropenscilabs/pkgreviewr")

pkgreviewr::pkgreview_create(pkg_repo = "cboettig/rdflib", review_parent = "~/")

After reload:

library(pkgreviewr)
pkgreview_init(pkg_repo = "cboettig/rdflib")

Error in default_signature(repo) :
Error in 'git2r_signature_default': config value 'user.email' was not found

In terminal:

git config --global user.email "[email protected]"

RStudio:

pkgreview_init(pkg_repo = "cboettig/rdflib")

Overwrite pre-existing file 'rdflib'?
1: No way
2: Not now
3: Yup

Select 3.

✔ Writing 'pkgreview.md'
● Modify 'pkgreview.md'

Error in fallback_or_stop(fallback, "Cannot find GitHub username for email") :
Cannot find GitHub username for email

Session Info

R version 3.4.3 (2017-11-30)

Platform: x86_64-pc-linux-gnu (64-bit)

locale:
LC_CTYPE=en_US.UTF-8, LC_NUMERIC=C, LC_TIME=en_US.UTF-8, LC_COLLATE=en_US.UTF-8, LC_MONETARY=en_US.UTF-8, LC_MESSAGES=C, LC_PAPER=en_US.UTF-8, LC_NAME=C, LC_ADDRESS=C, LC_TELEPHONE=C, LC_MEASUREMENT=en_US.UTF-8 and LC_IDENTIFICATION=C

attached base packages:
stats, graphics, grDevices, utils, datasets, methods and base

other attached packages:
pkgreviewr(v.0.1.0)

loaded via a namespace (and not attached):
Rcpp(v.0.12.15), rstudioapi(v.0.7), knitr(v.1.19), magrittr(v.1.5), usethis(v.1.2.0), devtools(v.1.13.4), R6(v.2.2.2), httr(v.1.3.1), stringr(v.1.2.0), tools(v.3.4.3), git2r(v.0.21.0), withr(v.2.1.1), htmltools(v.0.3.6), yaml(v.2.1.16), rprojroot(v.1.3-2), digest(v.0.6.15), assertthat(v.0.2.0), crayon(v.1.3.4), whoami(v.1.1.2), ini(v.0.3.0), bitops(v.1.0-6), clisymbols(v.1.2.0), curl(v.3.1), RCurl(v.1.95-4.10), memoise(v.1.1.0), evaluate(v.0.10.1), rmarkdown(v.1.8), gh(v.1.0.1), stringi(v.1.1.6), pander(v.0.6.1), compiler(v.3.4.3), desc(v.1.1.1), backports(v.1.1.2) and jsonlite(v.1.5)

whoami::gh_username throwing testing error on Travis CI

Not sure how to get around the fact that during testing there is no github account associated with the system?

small request editor request template ;-)

very cool tools for editors!

I'd be in favor of not using the full list of authors in the request template because it could be too long?

Needs Testing suite!

using `usethis::git_sitrep()` instead of `whoami::gh_username()`

Can I suggest using usethis::git_sitrep() instead of whoami::gh_username() here? Or are you waiting for the usethis git functions to become more robust first? I know they've been flakey for a long time!

https://github.com/ropenscilabs/pkgreviewr/blob/fb9df99b1c50ea00e9c434e82f97374ca9cb2e7e/R/github.R#L40

Seems that whoami::gh_username() depends on having Sys.getenv("GITHUB_USERNAME") non-empty. Mine was empty, but I see I can set it with Sys.setenv(GITHUB_USERNAME = "benmarwick")

I wonder why I need to sinceusethis::git_sitrep() gives a full output even when Sys.getenv("GITHUB_USERNAME") is empty. So mysterious!

Anyway, just a thought!

sessionInfo()
R version 3.6.0 (2019-04-26)
Platform: x86_64-apple-darwin15.6.0 (64-bit)
Running under: macOS Mojave 10.14.6

Matrix products: default
BLAS:   /System/Library/Frameworks/Accelerate.framework/Versions/A/Frameworks/vecLib.framework/Versions/A/libBLAS.dylib
LAPACK: /Library/Frameworks/R.framework/Versions/3.6/Resources/lib/libRlapack.dylib

locale:
[1] en_US.UTF-8/en_US.UTF-8/en_US.UTF-8/C/en_US.UTF-8/en_US.UTF-8

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base     

other attached packages:
[1] pkgreviewr_0.1.1.9000

loaded via a namespace (and not attached):
 [1] Rcpp_1.0.2        rstudioapi_0.10   whisker_0.4       magrittr_1.5      usethis_1.5.1    
 [6] tidyselect_0.2.5  R6_2.4.0          rlang_0.4.0       httr_1.4.1        dplyr_0.8.3      
[11] tools_3.6.0       packrat_0.5.0     withr_2.1.2       git2r_0.26.1.9000 rprojroot_1.3-2  
[16] assertthat_0.2.1  tibble_2.1.3      crayon_1.3.4      whoami_1.3.0      purrr_0.3.2      
[21] base64enc_0.1-3   fs_1.3.1          clisymbols_1.2.0  triebeard_0.3.0   curl_4.0         
[26] glue_1.3.1        gh_1.0.1          compiler_3.6.0    pillar_1.4.2      urltools_1.7.3   
[31] desc_1.2.0        backports_1.1.4   jsonlite_1.6      pkgconfig_2.0.2

Handle the need for global user.name and user.email parameters better.

Perhaps allow user to supply them if they are not detected with a nudge to set them up properly?

Criteria before transfer to ropensci?

The repo should eventually be transferred to ropensci, maybe after doing the following:

Removing the use of unexported functions #3
README overhaul #26

Once we transferred the repo, @annakrystalli would you like to write a tech note about the package? (or a blog post? cc @stefaniebutland )

properly import non-exported functions.

Checks note (and SO discussion shows) that ::: function calling within packages is not permitted on CRAN.

To import correctly, Include details in roxygen function documentation, following

#' @importFrom utils getFromNamespace

convention and remove ::: notation in functions.

pre-commit git hook for index.Rmd & index.nb.html

Like the one implemented by usethis for README.Rmd and REAME.md

Failing installation - dependency

Hi, Thanks for developing this package. I ran into this issue. Should i try installing the dependenices prior to the package installation?


> devtools::install_github('annakrystalli/pkgreviewr')
Downloading GitHub repo annakrystalli/pkgreviewr@master
from URL https://api.github.com/repos/annakrystalli/pkgreviewr/zipball/master
Installing pkgreviewr
Installing 1 package: covr
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
also installing the dependency ‘rex’

trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/rex_1.1.2.zip'
Content type 'application/zip' length 102163 bytes (99 KB)
downloaded 99 KB

trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/covr_3.0.1.zip'
Content type 'application/zip' length 119734 bytes (116 KB)
downloaded 116 KB

package ‘rex’ successfully unpacked and MD5 sums checked
package ‘covr’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: git2r
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/git2r_0.21.0.zip'
Content type 'application/zip' length 3029704 bytes (2.9 MB)
downloaded 2.9 MB

package ‘git2r’ successfully unpacked and MD5 sums checked
Warning: cannot remove prior installation of package ‘git2r’

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: here
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/here_0.1.zip'
Content type 'application/zip' length 16784 bytes (16 KB)
downloaded 16 KB

package ‘here’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: RCurl
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/RCurl_1.95-4.10.zip'
Content type 'application/zip' length 2869612 bytes (2.7 MB)
downloaded 2.7 MB

package ‘RCurl’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: reprex
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/reprex_0.1.2.zip'
Content type 'application/zip' length 34488 bytes (33 KB)
downloaded 33 KB

package ‘reprex’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: whoami
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/whoami_1.1.2.zip'
Content type 'application/zip' length 21307 bytes (20 KB)
downloaded 20 KB

package ‘whoami’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Downloading GitHub repo r-lib/usethis@master
from URL https://api.github.com/repos/r-lib/usethis/zipball/master
Installing usethis
Installing 1 package: backports
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/backports_1.1.2.zip'
Content type 'application/zip' length 54964 bytes (53 KB)
downloaded 53 KB

package ‘backports’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: curl
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/curl_3.1.zip'
Content type 'application/zip' length 3470642 bytes (3.3 MB)
downloaded 3.3 MB

package ‘curl’ successfully unpacked and MD5 sums checked
Warning: cannot remove prior installation of package ‘curl’

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: git2r
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/git2r_0.21.0.zip'
Content type 'application/zip' length 3029704 bytes (2.9 MB)
downloaded 2.9 MB

package ‘git2r’ successfully unpacked and MD5 sums checked
Warning: cannot remove prior installation of package ‘git2r’

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: rematch2
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/rematch2_2.0.1.zip'
Content type 'application/zip' length 34777 bytes (33 KB)
downloaded 33 KB

package ‘rematch2’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: rprojroot
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/rprojroot_1.3-2.zip'
Content type 'application/zip' length 70199 bytes (68 KB)
downloaded 68 KB

package ‘rprojroot’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
Installing 1 package: styler
Installing package into ‘C:/Users/Sabi/Documents/R/win-library/3.4’
(as ‘lib’ is unspecified)
also installing the dependencies ‘cli’, ‘enc’

trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/cli_1.0.0.zip'
Content type 'application/zip' length 304938 bytes (297 KB)
downloaded 297 KB

trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/enc_0.1.zip'
Content type 'application/zip' length 50596 bytes (49 KB)
downloaded 49 KB

trying URL 'https://cran.rstudio.com/bin/windows/contrib/3.4/styler_1.0.0.zip'
Content type 'application/zip' length 139196 bytes (135 KB)
downloaded 135 KB

package ‘cli’ successfully unpacked and MD5 sums checked
package ‘enc’ successfully unpacked and MD5 sums checked
package ‘styler’ successfully unpacked and MD5 sums checked

The downloaded binary packages are in
	C:\Users\Sabi\AppData\Local\Temp\RtmpQ5wyeS\downloaded_packages
"C:/PROGRA~1/R/R-34~1.2/bin/x64/R" --no-site-file --no-environ --no-save --no-restore --quiet CMD  \
  INSTALL "C:/Users/Sabi/AppData/Local/Temp/RtmpQ5wyeS/devtools1310487c76be/r-lib-usethis-42c19e4"  \
  --library="C:/Users/Sabi/Documents/R/win-library/3.4" --install-tests 

ERROR: dependencies 'curl', 'git2r' are not available for package 'usethis'
* removing 'C:/Users/Sabi/Documents/R/win-library/3.4/usethis'
Installation failed: Command failed (1)
"C:/PROGRA~1/R/R-34~1.2/bin/x64/R" --no-site-file --no-environ --no-save --no-restore --quiet CMD  \
  INSTALL  \
  "C:/Users/Sabi/AppData/Local/Temp/RtmpQ5wyeS/devtools13104dfc6952/annakrystalli-pkgreviewr-3b32967"  \
  --library="C:/Users/Sabi/Documents/R/win-library/3.4" --install-tests 

ERROR: dependencies 'git2r', 'usethis', 'goodpractice' are not available for package 'pkgreviewr'
* removing 'C:/Users/Sabi/Documents/R/win-library/3.4/pkgreviewr'
Installation failed: Command failed (1)
>

User feedback

Would be great to understand whether folks have tried using the package and whether the materials worked / helped them.

Please feel free to leave any general feedback here, even just that you're trying it. Of course feel free to open specific issues if that makes more sense.

devtools::install_github not installing remote dependencies

These in particular

Remotes: cscheid/rgithub,
    MangoTheCat/goodpractice

Related to #6

MEE template - Inspiration from Nick Golding

ropensci/ozunconf17#14

https://github.com/goldingn/auto

Cloning package source through git2r fails on macOSX

Failure related to ropensci/git2r#331

Include checklist and guidelines for statistical packages

I'm handling my first statistical package submission as an editor and using this package for my initial checks before looking for reviewers.

I note that the guidelines automatically point to the regular rOpenSci package categories only. I was double-checking the fit of the package and it didn't fit until I scrolled about and clicked on the special section for statistical packages.

Remove requirement for Rstudio

Related to #11 and ropensci/dev_guide#183.

I wonder if we could give the option to easily do away with rstudio dependency by purling the index.Rmd into an .R script. @adamhsparks, would a testing workflow in a script be better for you?

automatic submission

Also a feature idea: being able to submit from the command line. With maybe one or two questions like in devtools::release, e.g. "Ready to submit?"

make it clearer that there'll be two RStudio projects

I think it wasn't 100% clear in my head at first. This is either a suggestion for the docs or a way for you to see I got it all wrong 😂

The README could state that the goal of this package is to help you create an RStudio project with the review, and to automatically setup a second RStudio project with the package. The reviewing will happen by juggling between the two projects. The review package itself will help you go through the review by having all steps lined out in a document where you can record your answers and tests. In the future: it will also help you submit your review automatically.

add some checks when downloading files

E.g. when downloading the template, try again a few times?

Change license to align with usethis license

Change to GLP3 as per discussion in #3 re style.R

Author names not parsed correctly when entered as single character string

Parsing of Author names onto templates doesn't work when they are not entered as Authors@R on DESCRIPTION.

Perhaps a function that processes the name and also incorporates #49 could work.

Ultimately though, this should be flagged as incorrect storing of author details at editor's checks/review.

Such checks could therefore be automated at this stage and a comment added to the editors.md/review.md during intitialisation. Perhaps such a function, that flags common errors that aren't picked up by check() and goodpractice could live in rodev() and print out an initial report as the first comments of any response template. Does this make sense @maelle ? Would love to hear your thoughts on this.

Error when setting up a new editor review

> pkgreview_create("popecol/rangr",
                  review_parent = "~/Developer/GitHub/rOpenSci/reviews/",
                  template = "editor",
                  issue_no = 595)

Clones the repo to the correct directory but then errors with:

Error in pkgreview_getdata(pkg_dir = pkg_dir, pkg_repo, template = template,  : 
  object 'package_data' not found

The examples do the same when I run them as-is and put the repo in "~/Documents".

review in the open

I like that this package means that a reviewer can make open the whole review process, but I can imagine reviewers not being at ease with their experiments being public, so maybe a sentence could be added about that somewhere? 1) one can create a private GitHub repo at the beginning (it's an option of usethis::use_github) if one has the correspondong GitHub subscription 2) one could mention the idea of pushing at the very end.

That said I think we should encourage the open reviewing, so the phrasing should be cautious. I just wouldn't like shy first-timer reviewers to be put off?

install(pkg_dir, dependencies = T, build_vignettes = T)
Error in install(pkg_dir, dependencies = T, build_vignettes = T) : 
  could not find function "install"