Open editorialbot opened 6 months ago
Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.
For a list of things I can do to help you, just type:
@editorialbot commands
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
@editorialbot generate pdf
Software report:
github.com/AlDanial/cloc v 1.90 T=0.03 s (1795.8 files/s, 138885.9 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
Python 26 226 81 1167
Markdown 4 170 0 517
CSV 6 0 0 299
YAML 3 6 0 204
TeX 1 13 0 160
JSON 3 0 0 150
Jupyter Notebook 3 0 598 139
make 1 15 0 67
Dockerfile 2 0 0 35
Bourne Shell 1 3 5 12
-------------------------------------------------------------------------------
SUM: 50 433 684 2750
-------------------------------------------------------------------------------
Commit count by author:
125 Fernando
111 Simon Duarte
91 Evaristo Rojas
60 siduartep
19 Xavier Paredes
16 Guillermo Olvera
12 Evaristo Rojas • GECI
10 Mario Villasante
9 Nepo Rojas
7 Nepo Rojas • GECI
3 Guillermo Olvera • GECI
3 MemoOlv
2 devarops
2 mvillasante
1 nepito
Paper file info:
📄 Wordcount for paper.md
is 1574
✅ The paper includes a Statement of need
section
License info:
🟡 License found: GNU Affero General Public License v3.0
(Check here for OSI approval)
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1007/s10530-008-9402-3 is OK
- 10.1098/rsbl.2003.0153 is OK
- 10.1016/0272-7714(86)90028-4 is OK
- 10.1016/j.gecco.2015.02.010 is OK
- 10.1111/j.1523-1739.2007.00859.x is OK
- 10.3354/meps06860 is OK
- 10.1016/j.biocon.2014.10.014 is OK
- 10.1111/j.1365-2486.2011.02464.x is OK
- 10.1038/35002501 is OK
- 10.5281/zenodo.10214344 is OK
- 10.1007/s10530-005-0421-z is OK
MISSING DOIs
- No DOI given, and none found for title: The spread of commensal species of Rattus to ocean...
- No DOI given, and none found for title: Habitat use by three rat species (Rattus spp.) on ...
- No DOI given, and none found for title: Linking marine and terrestrial food webs: Allochth...
INVALID DOIs
- None
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Dear @ashleefv, @jhabriel and @david-yannick, thank you again for accepting review this submission for JOSS.
The reviewing process is checklist based, and instructions were already posted above by the editorial bot - but let me know if you need any assistance, ok? Also, you can tag @devarops if you have specific questions about the manuscript.
@devarops, you can tag your co-authors GitHub accounts if you want, so they will be able to follow this issue and answer to questions as well.
Regarding contribution and authorship: @devarops is the only of the three listed authors that appears to have contributed to the repository. There are 7 other repository contributors who are not listed as JOSS paper authors.
I have several additional comments.
Paper.md
readme.md
examples/calibration-demo.ipynb
examples/proceedings.ipynb
examples/tiling_demo.ipynb
Throughout the nerd repository
from . import
from .. import
with the specific absolute paths, e.g., in nerd\calibration\best_density_function.py
from nerd.calibration import get_rmse_from_function_array
from nerd import density_functions as df
PEP 8 standard explicitly recommends absolute imports: https://realpython.com/absolute-vs-relative-python-imports/ This recommendation applies to the following scripts:
nerd/calibration/init.py nerd/calibration/best_density_function.py nerd/calibration/model.py nerd/calibration/rmse.py nerd/density_functions/init.py nerd/io/init.py nerd/mapping/init.py nerd/init.py
Thank you, @ashleefv, for your thoughtful review and valuable feedback. We are currently addressing your comments and suggestions, and we are confident that your insights will significantly enhance the quality of our paper.
I have finished my review of the NERD package. I also have some additional comments/suggestions, which are given below.
pip
works fine. I also tested the docker version and it works as stated. However, I would recommend including the option of installing NERD
from source (this will be interesting for someone who wants to work with the development version rather than the stable version). To allow for this, you will need to include a requirements.txt
file with the package dependencies and the instructions on how to install from source.README
the Python versions that NERD
supports.I would strongly recommend adding a CITATION.cff
file. See https://citation-file-format.github.io/
CODE_OF_CONDUCT.md
file. See https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project CONTRIBUTING.md
file, where there are clear guidelines on how one can contribute to the project. Specifically, are the formatting (flake8, isort, black), typing (mypy) , testing (pytest) requirements before opening a pull request. Classes/Functions/Methods that are lacking docstrings:
Classes/Functions/Methods that are lacking type hints:
plt.savefig
commands, and simply go for plt.show()
.My review is complete, below are a few comments and questions:
Hi! Scanning back a bit in this review, I see some comments from reviewers. @devarops have you had a chance to address these comments?
Hi @kthyng! I've reviewed the comments from @ashleefv, @jhabriel, and @david-yannick, and I’m currently working on addressing them. I'll provide an update by the end of the week.
@kthyng: Here's an update on our progress:
@ashleefv
.@jhabriel
:
I'll provide a new update by the end of next week.
Thank you @devarops!
Hi @kthyng,
This week, we addressed all of @jhabriel
's observations regarding the community guidelines.
I'll keep you updated on our progress in addressing the rest of the reviewers' comments.
thanks @devarops!
Hi @kthyng,
This week, we addressed two of @ashleefv
's comments on examples/tiling_demo.ipynb
and began working on some of @jhabriel
's comments regarding the missing docstrings.
Hi @kthyng,
We have addressed all of @jhabriel
's comments regarding the missing docstrings and typing. We will keep working on the rest of the observations.
Hi @kthyng,
We have addressed some of @jhabriel
's and @ashleefv
's comments. So far, we've addressed 78% of @ashleefv
's observations and 98% of @jhabriel
's.
Submitting author: !--author-handle-->@devarops<!--end-author-handle-- (Evaristo Rojas Mayoral) Repository: https://github.com/IslasGECI/nerd Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: !--editor-->@marcosvital<!--end-editor-- Reviewers: @ashleefv, @jhabriel, @david-yannick Archive: Pending
Status
Status badge code:
Reviewers and authors:
Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)
Reviewer instructions & questions
@ashleefv & @jhabriel & @david-yannick, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @marcosvital know.
✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨
Checklists
📝 Checklist for @ashleefv
📝 Checklist for @david-yannick
📝 Checklist for @jhabriel