Open ZherenXu 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: 45 minutes
numpy
can be referred to.ci-cd.yml
has already pushed the package to PyPI
, the installation method needs to update that the package can also be installed by using pip
.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: 1hr
def test_dist_pll_lines_2d_int():
"""Tests the distance between two parallel lines with integer input"""
....
def test_dist_pll_lines_2d_float():
"""Tests the distance between two parallel lines with integer input"""
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
$ pip install git+https://github.com/UBC-MDS/CoordGeomPy.git@v1.0.0
and the functions don't work under the 1.0.0 release! dist_pll_lines_2d
should be updated so the parameters m
,b1
, b2
can be integers or floats. Right now, the docstrings say to use floats, but the test explicitly test for integers or floats1PyPI
site directly in the README! Overall, this was an extremely well done package and I'm impressed by the quality achieved in a few short weeks. I apologize for the nit-picky comments - it was hard to find things to comment on! So don't take these critiques too harshly. 😃 Great job!
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
I really enjoyed reviewing this package, and I think the idea behind it is very practical. As others have mentioned, there is very minor stuff that could be considered further.
It would be good to consider updating the installation on README file to pip install coordgeompy
which is an easier way to install the package for the user rather than using the GitHub repo.
I really liked the testing of the package. I think different test functions for different purposes is definitely organized very well and is easy to read.
It would have been a good idea to include docstrings for all testing functions. For example, there is no docstring for test_is_orthogonal_T()
and def test_is_orthogonal_F()
.
For the usage, I think it would have been a good idea to use an existing data set with more observations to show the usage of your package. And, as others have mentioned, expanding a bit more on the usage would be a good idea.
I think since the functions in this package recreate functions that already exist in other packages, it would have been good to explain why a user might want to use coordgeompy
over other packages in the motivation section
The functions under the installation instruction on README don't work, which as mentioned seems to be a versioning issue in the link.
Very detailed docstrings for the functions that help the user understand what each of them do, and in particular, I found the defensive programming to be very impressive.
Again, great job!
Submitting Author: Arlin Cherian(@arlincherian), Jordan Casoli(@jcasoli), Nico Van den Hooff(@nicovandenhooff), Zheren Xu(@ZherenXu)
Package Name: coordgeompy One-Line Description of Package: A simple coordinate geometry helper package Repository Link: https://github.com/UBC-MDS/coordgeompy Version submitted: v2.0.0 Editor: TBD
Reviewer 1: Vera Cui Reviewer 2: Jasmine ORTEGA Reviewer 3: Mel Liow Reviewer 4: Anahita Einolghozati
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.
Explain how the and why the package falls under these categories (briefly, 1-2 sentences): The coordgeompy package provides simple calculations for geometry data.
Who is the target audience and what are scientific applications of this package?
Data analysts, statisticians or any other R users who need to do simple geometry calculations.
Are there other Python packages that accomplish the same thing? If so, how does yours differ? SymPy is a Python library that contains comprehensive mathematical functions including intersection of lines, shortest distance between a point and a line etc. We also found a package coordinate-geometry 1.0.02 that had similar functions to calculating distance between two points, a point and a line, area of a triangle etc. We are not really reinventing the wheel on coordinate geometry calculations with our package, we used this as an opportunity to gain some experience in understanding how these calculations function in python language.
If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or
@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