statdivlab / rigr

Regression, Inference, and General Data Analysis Tools for R
Other
10 stars 3 forks source link

JOSS review: Remind users that the remotes package needs to be available to install the dev version #135

Closed tomsing1 closed 1 year ago

tomsing1 commented 1 year ago

Congratulations on a great R package! Just a suggestion:

The instructions in the Readme.Rmd file to install the development version requires the remotes package to be available on the user's system. That requirement is indicated by the remotes::install_github double colon notation, which is familiar to advanced R users. Perhaps consider adding # install.packages("remotes") as a comment above this command to remind users that remotes needs to be installed first? (Just a suggestion, not an obstacle to accepting the paper.)

If you want to get fancy, you could even include something like this:

if (!requireNamespace("remotes", quietly = TRUE)) {
  install.package("remotes")
}

Just a thought, though, feel free to ignore!

yiqunchen commented 1 year ago

We have revised the readme files to incorporate this suggestion (0d5f6eb2fa82bd80b3e41fadcdcb90a6694102eb) -- thank you for your keen observations and prompt reviews!!