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
[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).
Documentation
The package includes all the following forms of documentation:
[x] A statement of need clearly stating problems the software is designed to solve and its target audience in README
[x] Installation instructions: for the development version of package and any non-standard dependencies in README
[ ] Vignette(s) demonstrating major functionality that runs successfully locally
[ ] Function Documentation: for all user-facing functions
[ ] Examples for all user-facing functions
[x] Community guidelines including contribution guidelines in the README or CONTRIBUTING.
[x] Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a setup.py file or elsewhere.
Readme requirements
The package meets the readme requirements below:
[x] Package has a README.md file in the root directory.
The README should include, from top to bottom:
[x] The package name
[ ] Badges for continuous integration and test coverage, a repostatus.org badge, and any other badges. If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the badge for pyOpenSci peer-review will be provided upon acceptance.)
[x] Short description of goals of package, with descriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README.
[x] Installation instructions
[ ] Any additional setup required (authentication tokens, etc)
[x] Brief demonstration usage
[ ] Direction to more detailed documentation (e.g. your documentation files or website).
[ ] If applicable, how the package compares to other similar packages and/or how it relates to other packages
[x] Citation information
Usability
Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Package structure should follow general community best-practices. In general please consider:
[ ] The documentation is easy to find and understand
[ ] The need for the package is clear
[ ] All functions have documentation and associated examples for use
Functionality
[x] Installation: Installation succeeds as documented.
[x] Functionality: Any functional claims of the software been confirmed.
[ ] Performance: Any performance claims of the software been confirmed.
[x] Automated tests: Tests cover essential functions of the package and a reasonable range of inputs and conditions. All tests pass on the local machine.
[x] Continuous Integration: Has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.
[ ] Packaging guidelines: The package conforms to the pyOpenSci packaging guidelines.
For packages co-submitting to JOSS
[ ] The package has an obvious research application according to JOSS's definition in their submission requirements.
Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.
[ ] A short summary describing the high-level functionality of the software
[ ] Authors: A list of authors with their affiliations
[ ] A statement of need clearly stating problems the software is designed to solve and its target audience.
[ ] References: with DOIs for all those that have one (e.g. papers, datasets, software).
Final approval (post-review)
[ ] The author has responded to my review and made changes to my satisfaction. I recommend approving this package.
Estimated hours spent reviewing:
2 hours
Review Comments
You may consider adding the ci /cd and codecov badges in the readme.
Readthedoc link does not work. It shows error on readthedoc. Without access to readthedoc, the sample usage on readme shows the output image only, making it difficult to understand how to use the package. docs/example.ipynb is not completed as well.
Examples are missing for the docstring of plot_freq() function.
You may describe where your packages fit into the Python ecosystem (are there any other Python packages that have the same/similar functionality) in the readme.
To make it easier for users, you may also consider adding links / tutorials on how to generate the personal ‘bearer token’ for the get_store() function.
Package Review
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
Documentation
The package includes all the following forms of documentation:
setup.pyfile or elsewhere.Readme requirements The package meets the readme requirements below:
The README should include, from top to bottom:
Usability
Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole. Package structure should follow general community best-practices. In general please consider:
Functionality
For packages co-submitting to JOSS
Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.
The package contains a
paper.mdmatching JOSS's requirements with:Final approval (post-review)
Estimated hours spent reviewing:
2 hours
Review Comments
Originally posted by @ming0701 in https://github.com/UBC-MDS/software-review-2022/issues/62#issuecomment-1029528954