Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PRE REVIEW]: harmonize-wq: Standardize, clean and wrangle Water Quality Portal data into more analytic-ready formats #7135

Closed
editorialbot opened this issue Aug 22, 2024 · 31 comments
Assignees
Labels
pre-review pyOpenSci Submissions associated with pyOpenSci Python TeX Track: 6 (ESE) Earth Sciences and Ecology

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Aug 22, 2024

Submitting author: @jbousquin (Justin Bousquin)
Repository: https://github.com/USEPA/harmonize-wq
Branch with paper.md (empty if default branch): paper_JOSS
Version: 0.5.0
Editor: @kthyng
Reviewers: @kthyng
Managing EiC: Kristen Thyng

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/cf3275a731d860635d261fb0388fa791"><img src="https://joss.theoj.org/papers/cf3275a731d860635d261fb0388fa791/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/cf3275a731d860635d261fb0388fa791/status.svg)](https://joss.theoj.org/papers/cf3275a731d860635d261fb0388fa791)

Author instructions

Thanks for submitting your paper to JOSS @jbousquin. Currently, there isn't a JOSS editor assigned to your paper.

@jbousquin if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands
@editorialbot editorialbot added pre-review Track: 6 (ESE) Earth Sciences and Ecology labels Aug 22, 2024
@editorialbot
Copy link
Collaborator Author

Hello human, 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

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.21105/joss.03485 is OK
- 10.1016/j.envsoft.2021.105210 is OK
- 10.5066/P9X4L3GE is OK
- 10.1371/journal.pone.0239691 is OK
- 10.5066/P94I5TX3 is OK
- 10.5281/zenodo.5573592 is OK
- 10.1002/eap.2130 is OK
- 10.1029/2019WR024883 is OK
- 10.1021/acs.est.9b06406 is OK
- 10.1038/s41597-020-0478-7 is OK
- 10.1016/j.watres.2016.12.024 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Pint: Operate and manipulate physical quantities i...
- No DOI given, and none found for title: Tidy data
- No DOI given, and none found for title: WQX Web Application Programming Interface (API)
- No DOI given, and none found for title: WQX Web User Guide

❌ MISSING DOIs

- None

❌ INVALID DOIs

- 10.1111/j.17521688.2011.00573.x is INVALID

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.13 s (339.6 files/s, 355960.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          12            998           3491           2592
Jupyter Notebook                 7              0          37867            685
YAML                             8             51             55            302
TeX                              1             15              0            160
reStructuredText                 9            115            124            152
Markdown                         2             47              0            131
Rmd                              1             63            164             48
TOML                             1              7              0             39
DOS Batch                        1              8              1             26
make                             1              4              7              9
JSON                             2              0              0              8
-------------------------------------------------------------------------------
SUM:                            45           1308          41709           4152
-------------------------------------------------------------------------------

Commit count by author:

   329	Bousquin
   112	Justin Bousquin
     9	Cristina Mullin
     2	Romain Caneill
     2	cristinamullin
     1	Mullin
     1	Timothy Hodson

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 1086

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

✅ License found: MIT License (Valid open source OSI approved license)

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

The fqar package: R tools for analyzing floristic quality assessment data
Submitting author: @equitable-equations
Handling editor: @mikemahoney218 (Active)
Reviewers: @ifoxfoot, @mhesselbarth
Similarity score: 0.7196

tidyhydat: Extract and Tidy Canadian Hydrometric Data
Submitting author: @boshek
Handling editor: @arfon (Active)
Reviewers: @arfon
Similarity score: 0.7089

tbeptools: An R package for synthesizing estuarine data for environmental research
Submitting author: @fawda123
Handling editor: @kthyng (Active)
Reviewers: @paleolimbot, @richardsc
Similarity score: 0.6941

tidyqpcr: Quantitative PCR analysis in the tidyverse.
Submitting author: @ewallace
Handling editor: @arfon (Active)
Reviewers: @arfon
Similarity score: 0.6937

HyRiver: Hydroclimate Data Retriever
Submitting author: @cheginit
Handling editor: @kthyng (Active)
Reviewers: @raoulcollenteur, @arbennett
Similarity score: 0.6900

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

@kthyng
Copy link

kthyng commented Aug 22, 2024

Hi @jbousquin and thanks for your submission! I am looking for some specific items to make sure your submission fits our requirements at a high level (not at the more detailed review level) before moving on to finding an editor or putting this on our waitlist if no relevant editors are available. I'll comment over time as I have a chance to go through them:

In the meantime, please take a look at the comments above ⬆️ from the editorialbot to address any DOI, license, or paper issues if you're able (there may not be any).

I see that this has already been reviewed in pyOpenSci here: pyOpenSci/software-submission#157

@jbousquin
Copy link

Hi @kthyng and thank you! From editorialbot that invalid doi was maybe missing a dash (DOI: 10.1111/j.1752‐1688.2011.00573.x link), and tidy data should be https://doi.org/10.18637/jss.v059.i10. I'll work on a PR for those.

@jbousquin
Copy link

Made some minor updates to paper/paper.bib on the branch paper_JOSS. The doi editorialbot identified as invalid did contain the '-' but it wasn't being encoded correctly. Confirmed the doi link works as it should now in the pdf generated by the workflow.

@kthyng
Copy link

kthyng commented Aug 28, 2024

@editorialbot set paper_JOSS as branch

@editorialbot
Copy link
Collaborator Author

Done! branch is now paper_JOSS

@kthyng
Copy link

kthyng commented Aug 28, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

The fqar package: R tools for analyzing floristic quality assessment data
Submitting author: @equitable-equations
Handling editor: @mikemahoney218 (Active)
Reviewers: @ifoxfoot, @mhesselbarth
Similarity score: 0.7202

tidyhydat: Extract and Tidy Canadian Hydrometric Data
Submitting author: @boshek
Handling editor: @arfon (Active)
Reviewers: @arfon
Similarity score: 0.7092

tidyqpcr: Quantitative PCR analysis in the tidyverse.
Submitting author: @ewallace
Handling editor: @arfon (Active)
Reviewers: @arfon
Similarity score: 0.6947

tbeptools: An R package for synthesizing estuarine data for environmental research
Submitting author: @fawda123
Handling editor: @kthyng (Active)
Reviewers: @paleolimbot, @richardsc
Similarity score: 0.6935

A Framework to Quality Control Oceanographic Data
Submitting author: @castelao
Handling editor: @kthyng (Active)
Reviewers: @jessicaaustin, @evanleeturner
Similarity score: 0.6934

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

@kthyng
Copy link

kthyng commented Aug 28, 2024

@jbousquin a few paper comments (still need to read through in detail)

  • the parenthetical references aren't in there correctly. You'll want to create a list of them rather than listed one, then another, each with parentheses. Here is an example paper: https://joss.readthedocs.io/en/latest/example_paper.html#example-paper
  • Please check the capitalization in your references. You can preserve capitalization by placing {} around characters/words in your .bib file. For example, "r" is not capitalized, but please check others.
  • You and I are the only people that will be reading your paper so please check everything carefully! Usually reviewers and an editor would also be checking, but your repo was already reviewed so the paper will only be checked by us.

@kthyng
Copy link

kthyng commented Sep 10, 2024

@jbousquin Can you check through your paper? I can also wait and start the review issue before we go into these details if you prefer.

@jbousquin
Copy link

@kthyng have made those changes but have to wait to merge until I’m back in the office next week (should be Tuesday). I will give it another final read through then for any copy edits as well.

@jbousquin
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

tidyhydat: Extract and Tidy Canadian Hydrometric Data
Submitting author: @boshek
Handling editor: @arfon (Active)
Reviewers: @arfon
Similarity score: 0.7393

wdpar: Interface to the World Database on Protected Areas
Submitting author: @jeffreyhanson
Handling editor: @martinfleis (Active)
Reviewers: @Jo-Schie, @DrMattG
Similarity score: 0.7336

nsink: An R package for flow path nitrogen removal estimation
Submitting author: @jhollist
Handling editor: @crvernon (Active)
Reviewers: @jmp75, @ldecicco-USGS, @jmp75
Similarity score: 0.7314

HyRiver: Hydroclimate Data Retriever
Submitting author: @cheginit
Handling editor: @kthyng (Active)
Reviewers: @raoulcollenteur, @arbennett
Similarity score: 0.7241

The fqar package: R tools for analyzing floristic quality assessment data
Submitting author: @equitable-equations
Handling editor: @mikemahoney218 (Active)
Reviewers: @ifoxfoot, @mhesselbarth
Similarity score: 0.7216

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

@jbousquin
Copy link

@kthyng those comments should be resolved in the latest version and ready for your detailed read-through.

@kthyng kthyng added the pyOpenSci Submissions associated with pyOpenSci label Sep 30, 2024
@kthyng
Copy link

kthyng commented Sep 30, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

tidyhydat: Extract and Tidy Canadian Hydrometric Data
Submitting author: @boshek
Handling editor: @arfon (Active)
Reviewers: @arfon
Similarity score: 0.7394

wdpar: Interface to the World Database on Protected Areas
Submitting author: @jeffreyhanson
Handling editor: @martinfleis (Active)
Reviewers: @Jo-Schie, @DrMattG
Similarity score: 0.7337

nsink: An R package for flow path nitrogen removal estimation
Submitting author: @jhollist
Handling editor: @crvernon (Active)
Reviewers: @jmp75, @ldecicco-USGS, @jmp75
Similarity score: 0.7315

HyRiver: Hydroclimate Data Retriever
Submitting author: @cheginit
Handling editor: @kthyng (Active)
Reviewers: @raoulcollenteur, @arbennett
Similarity score: 0.7241

The fqar package: R tools for analyzing floristic quality assessment data
Submitting author: @equitable-equations
Handling editor: @mikemahoney218 (Active)
Reviewers: @ifoxfoot, @mhesselbarth
Similarity score: 0.7216

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

@kthyng
Copy link

kthyng commented Sep 30, 2024

@editorialbot add me as editor

@editorialbot
Copy link
Collaborator Author

Assigned! @kthyng is now the editor

@kthyng
Copy link

kthyng commented Sep 30, 2024

@editorialbot add @kthyng as reviewer

@editorialbot
Copy link
Collaborator Author

@kthyng added to the reviewers list!

@kthyng
Copy link

kthyng commented Sep 30, 2024

@editorialbot start review

@editorialbot
Copy link
Collaborator Author

OK, I've started the review over in #7305.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pre-review pyOpenSci Submissions associated with pyOpenSci Python TeX Track: 6 (ESE) Earth Sciences and Ecology
Projects
None yet
Development

No branches or pull requests

3 participants