Advertisement
Guest User

Untitled

a guest
Jul 27th, 2017
54
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 2.63 KB | None | 0 0
  1. ## Package Review
  2.  
  3. *Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide*
  4.  
  5. - [x] As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor _before_ starting your review).
  6.  
  7. #### Documentation
  8.  
  9. The package includes all the following forms of documentation:
  10.  
  11. - [x] **A statement of need** clearly stating problems the software is designed to solve and its target audience in README
  12. - [x] **Installation instructions:** for the development version of package and any non-standard dependencies in README
  13. - [ ] **Vignette(s)** demonstrating major functionality that runs successfully locally
  14. - [ ] **Function Documentation:** for all exported functions in R help
  15. - [ ] **Examples** for all exported functions in R Help that run successfully locally
  16. - [ ] **Community guidelines** including contribution guidelines in the README or CONTRIBUTING, and DESCRIPTION with `URL`, `BugReports` and `Maintainer` (which may be autogenerated via `Authors@R`).
  17.  
  18. >##### Paper (for packages co-submitting to JOSS)
  19. >
  20. >The package contains a `paper.md` with:
  21. >
  22. >- [ ] **A short summary** describing the high-level functionality of the software
  23. >- [ ] **Authors:** A list of authors with their affiliations
  24. >- [ ] **A statement of need** clearly stating problems the software is designed to solve and its target audience.
  25. >- [ ] **References:** with DOIs for all those that have one (e.g. papers, datasets, software).
  26.  
  27. #### Functionality
  28.  
  29. - [x] **Installation:** Installation succeeds as documented.
  30. - [x] **Functionality:** Any functional claims of the software been confirmed.
  31. - [x] **Performance:** Any performance claims of the software been confirmed.
  32. - [x] **Automated tests:** Unit tests cover essential functions of the package
  33. and a reasonable range of inputs and conditions. All tests pass on the local machine.
  34. - [x] **Packaging guidelines**: The package conforms to the rOpenSci packaging guidelines
  35.  
  36. #### Final approval (post-review)
  37.  
  38. - [ ] **The author has responded to my review and made changes to my satisfaction. I recommend approving this package.**
  39.  
  40. Estimated hours spent reviewing: 1.5
  41.  
  42. ---
  43.  
  44. ### Review Comments
  45. - Well documented and consistent package!
  46. - I created a PR for some typos and to get through the CRAN policy of referring to other packages within apostrophes
  47. - @hrbrmstr's comments provide an excellent review of the security aspects of this package
  48. - A potential improvement to the documentation would be some diagrams, however, the vignettes do a great job anywayy
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement