Open nickmao1994 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.5 hours
$ pip install collinearity_tool
and I got the package installed without any issue. If it counts, I'm using a Mac machine.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 hr
[![Documentation Status](https://readthedocs.org/projects/collinearity-tool/badge/?version=latest)](https://collinearity-tool.readthedocs.io/en/latest/?badge=latest)
corr_heatmap
allows customization through the scheme
parameter. 👍 for customization!col_identitfy
in collinearity_tool.py
, there is a missing newline on line 170, which is causing the doc to render incorrectlyPlease 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
In README, you have included the dependencies of your package in the package ecosystem section. I think it would be good to have separate section for Motivation/Our place in Python ecosystem
section and Dependencies
.
You docstrings are great, however the functions could probably use a few more comments to increase readability. Not a big issue but would be nicer to read to fully understand what's going on.
For function vif_bar_plot, do you feel to have a default threshold value. Looking at beginner's perspective, many times people use functions without knowing purpose of threshold and having a default threshold could set a context and gives them opportunity to play with it according to their need.
Badges for ci-cd, code cov and documentation to reflect the status of your workflows and code coverage. Also, your code coverage (78.8%) could be improved as you are missing 18 lines.
I felt hard to find your package's documentation link and could only check example.ipynb but the bar chart was not rendered properly in it. Highly recommend adding documentation link in your README or documentation badge
In Usage, you can edit package name to collinearity_tool
instead of collinearity
as it could confuse readers.
Overall, this is a useful package and I enjoyed reviewing it. 👍
Submitting Author: Name (@github_handle)
Package Name: collinearity_tool One-Line Description of Package: Easy code to detect collinearity issues Repository Link: https://github.com/UBC-MDS/collinearity_tool Version submitted: 1.1.0 Editor: TBD
Reviewer 1: Francis Victor @Vikiano Reviewer 2: TZ Yan @ytz,
Reviewer 3: Karanpreet Kaur @karanpreetkaur
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: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