TommyJones
commented
2 days ago Hi. Thanks again for the review.
- I have a NEWS.md file that contains updates between versions. I add to the list as I make changes so the current state reflects changes to the development version. Does that meet the need you flagged?
- I'd rather not have dependencies listed in two places. I'm afraid that it would introduce the possibility of human error. (i.e., I will forget to update the README.) If acceptance of the package into JOSS hinges on this, I'll add dependencies to README, but I'd prefer not to.
tidytext, for example, does not list its dependencies in the README. - The vignettes are here. They're in R markdown format as CRAN does the PDF rendering on their end.
Do the above work for you?
maximelenormand
I managed to install both the CRAN and GitHub versions. In both cases, I ran the examples without any problems.
The differences between the current CRAN version and the development version are not clear. It would be nice to add a changelog somewhere to list all the changes made between the different (futur) CRAN versions and between the current CRAN version and the development GitHub version. It seems that there is no mention of either the CRAN or development GitHub version nor the way to install the package in the paper.
The dependencies are listed in the DESCRIPTION file but not in the README.
The package contains three vignettes that are not presented on the GitHub repository.
This is not mandatory, of course, but a nice way to address these issues could be to build a website for your package using pkgdown (https://pkgdown.r-lib.org/). A tidyverse template is available at https://github.com/tidyverse/tidytemplate.
#6800