Open y248guo opened 2 years ago
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
The package includes all the following forms of documentation:
setup.py
file or elsewhere.Readme requirements The package meets the readme requirements below:
The README should include, from top to bottom:
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:
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.md
matching JOSS's requirements with:
Estimated hours spent reviewing: 1 hour
Great job guys! I find slimeda
a very useful package for initial EDA of any numerical analysis. It is a fairly universal package for application in many fields. The package is organized well with clear differentiation between functions so that user can pick for their own usage.
I had no issues installing the package following the instructions on Windows. Good work!
It would be useful to update the documentations on readthedocs.io as well with the example usage like in the README.
A badge for code coverage could be included in README so that users can assess how robust the scripts are.
For the cat_unique_counts
function, there are additional packages such as pandas
and parse
that require further importing. It would be good if they could be incorporated in the function so that user can skip this step before running the function.
There is no link to the Contributing.md
file in the Contributing section of the README. Adding a link could be useful from a user perspective.
Author contact details could be included in the Code of Conduct.
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
The package includes all the following forms of documentation:
setup.py
file or elsewhere.Readme requirements The package meets the readme requirements below:
The README should include, from top to bottom:
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:
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.md
matching JOSS's requirements with:
Estimated hours spent reviewing: 1.5 hours
Overall, great job! This package is useful for EDA, which is the starting point for most analyses conducted by academics, students, and many data enthusiasts. Thank you for making our lives easy.
The README could include more details on how to exactly use each function. For example adding a line that says: from slimeda import histogram would make it easier for the user to load the function. Else, it requires the prior knowledge/expertise of someone downloading your package.
Similarly, providing an easy to use example would facilitate faster understanding. For example, if you had a sample data frame in your package and walked a user through it, that would make it more intuitive for a new user.
Consider adding a badge for code coverage.
I noticed a file called test_slimeda.py but its utility is not clear. Would it be worthwhile deleting, if this be the case?
Small typo in README - it is Spearman's "rank" and not "rand".
As mentioned by Adrianne, any additional dependencies (pandas for example), should be taken care of within the function.
Reviewer: Rakesh Pandey
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
The package includes all the following forms of documentation:
setup.py
file or elsewhere.Readme requirements The package meets the readme requirements below:
The README should include, from top to bottom:
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:
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.md
matching JOSS's requirements with:
Estimated hours spent reviewing: 1 hour
Excellent and practical EDA package! It encapsulates all of the code and details and provides us with a user-friendly package.
I understand that the information in the README file is extensive. However, adding example usage in the documentation, such as an example dataframe and the output for each function, would be helpful. https://slimeda.readthedocs.io/en/latest/example.html
Unused scripts such as src/sli
, eda/slimeda.py
, and tests/test slimeda.py
should be removed.
A link to contributing in the README would be useful, particularly for users who are reading the package from readthedocs.
It would be useful to include how input and output look in the usage section. Before we use any package, we usually look at these details.
There appears to be a typo in the README for the miss_counts function, as there is no dataframe in the OUTPUT section.
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
The package includes all the following forms of documentation:
setup.py
file or elsewhere.Readme requirements The package meets the readme requirements below:
The README should include, from top to bottom:
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:
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.md
matching JOSS's requirements with:
Estimated hours spent reviewing:
main
. Maybe it could be more systematic if all group members have a branch to make changes to the main repo.
name: Submit Software for Review about: Use to submit your Python package for peer review title: 'Slimeda' labels: 1/editor-checks, New Submission! assignees: ''
Submitting Authors: Simon Guo ( !--author1-->@y248guo<!--end-author1--) Anthea Chen ( !--author2-->@anthea98<!--end-author2--) Khalid Abdilahi ( !--author3-->@khalidcawl<!--end-author3--) Taiwo Owoseni ( !--author4-->@thayeylolu<!--end-author4--) Package Name: slimeda One-Line Description of Package: Slim package for doing exploratory data analysis (EDA) in Python Repository Link: https://github.com/UBC-MDS/slimeda Version submitted: v2.0 Editor: Simon Guo (@y248guo)
Reviewer 1: Alex Guo Reviewer 2: Nagraj Rao Reviewer 3: Adrianne Leung Reviewer 4: Rakesh Pandey Archive: TBD Version accepted: TBD
Description
Scope
* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see notes on categories of our guidebook.
@tag
the editor you contacted: (N/A)Technical checks
For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:
Publication options
JOSS Checks
- [ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements][JossSubmissionRequirements]. Be aware that completing the pyOpenSci review process **does not** guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS. - [ ] The package is not a "minor utility" as defined by JOSS's [submission requirements][JossSubmissionRequirements]: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria. - [ ] The package contains a `paper.md` matching [JOSS's requirements][JossPaperRequirements] with a high-level description in the package root or in `inst/`. - [ ] The package is deposited in a long-term repository with the DOI: *Note: Do not submit your package separately to JOSS*Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?
This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.
Code of conduct
P.S. *Have feedback/comments about our review process? Leave a comment here
Editor and Review Templates
Editor and review templates can be found here