openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
700 stars 36 forks source link

[REVIEW]: SSN2: The next generation of spatial stream network modeling in R #6389

Closed editorialbot closed 1 month ago

editorialbot commented 6 months ago

Submitting author: !--author-handle-->@michaeldumelle<!--end-author-handle-- (Michael Dumelle) Repository: https://github.com/USEPA/SSN2 Branch with paper.md (empty if default branch): develop Version: v0.2.0(JOSS) Editor: !--editor-->@mikemahoney218<!--end-editor-- Reviewers: @fernandomayer, @k-doering-NOAA, @fawda123 Archive: 10.5281/zenodo.12770259

Status

status

Status badge code:

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

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

@fernandomayer & @k-doering-NOAA, 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:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @mikemahoney218 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 @k-doering-NOAA

πŸ“ Checklist for @fawda123

πŸ“ Checklist for @fernandomayer

editorialbot commented 1 month ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1007/978-1-4614-7618-4 is OK
- 10.18637/jss.v067.i01 is OK
- 10.1016/j.fishres.2022.106583 is OK
- 10.1002/9781119115151 is OK
- 10.1002/2015wr018349 is OK
- 10.1371/journal.pone.0282524 is OK
- 10.1016/j.jtherbio.2021.103028 is OK
- 10.1111/rec.13626 is OK
- 10.5281/zenodo.4679423 is OK
- 10.1111/1752-1688.12372 is OK
- 10.1002/wat2.1023 is OK
- 10.1002/2017WR020969 is OK
- 10.1139/cjfas-2016-0247 is OK
- 10.1371/journal.pone.0239237 is OK
- 10.18637/jss.v063.i19 is OK
- 10.1086/710340 is OK
- 10.1016/j.scitotenv.2017.08.151 is OK
- 10.32614/CRAN.package.fields is OK
- 10.1016/j.cageo.2004.03.012 is OK
- 10.32614/RJ-2018-009 is OK
- 10.1890/08-1668.1 is OK
- 10.18637/jss.v056.i02 is OK
- 10.1111/j.1523-1739.2012.01897.x is OK
- 10.32614/CRAN.package.geoR is OK
- 10.1038/s41598-019-43132-7 is OK
- 10.1007/s10021-018-0311-8 is OK
- 10.32614/CRAN.package.broom is OK
- 10.18637/jss.v108.i10 is OK
- 10.1111/1752-1688.12543 is OK
- 10.1111/1365-2664.13997 is OK
- 10.1016/j.cageo.2014.02.009 is OK
- 10.1198/jasa.2009.ap08248 is OK
- 10.18637/jss.v056.i03 is OK
- 10.1007/978-0-387-98141-3 is OK
- 10.21105/joss.01686 is OK

MISSING DOIs

- No DOI given, and none found for title: rgeos: Interface to Geometry Engine - Open Source ...
- No DOI given, and none found for title: maptools: Tools for Handling Spatial Objects
- No DOI given, and none found for title: rgdal: Bindings for the ’Geospatial’ Data Abstract...
- No DOI given, and none found for title: Tidy modeling with R
- No DOI given, and none found for title: NHDPlus Version 2: User Guide
- No DOI given, and none found for title: National Stream Internet protocol and user guide
- No DOI given, and none found for title: Upcoming Changes to Popular R Packages for Spatial...
- No DOI given, and none found for title: SSNbler: Assemble SSN objects in R
- No DOI given, and none found for title: Mixed-effects models in S and S-PLUS
- No DOI given, and none found for title: Spatial Linear Models for Environmental Data

INVALID DOIs

- None
editorialbot commented 1 month ago

:wave: @openjournals/ese-eics, this paper is ready to be accepted and published.

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/5647, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

mikemahoney218 commented 1 month ago

Sorry folks -- I got slightly ahead of myself. One last issue before I hand back to the EiC:

@michaeldumelle , would you please archive the source code of your package, rather than the binary version?

michaeldumelle commented 1 month ago

Hi @mikemahoney218, in both the release tag and Zenodo archive, both the source and binaries are archived. Are you suggesting that the binaries should be removed, or is it okay that they are both there? Thanks!

mikemahoney218 commented 1 month ago

Oh, sorry, Zenodo's default display only showed me the contents of the .zip file and not the .tar.gz. I think it's fine that they're both there.

@openjournals/ese-eics please ignore my concern above, this one is good to go :smile:

mikemahoney218 commented 1 month ago

πŸŽ‰ With everything looking good on my end, it's time for me to hand this back to the EiC for last steps. Thanks @michaeldumelle for the submission, and thank you so much to @fernandomayer, @k-doering-NOAA, and @fawda123 for reviewing!

michaeldumelle commented 1 month ago

Thank you so much @fernandomayer, @k-doering-NOAA, @fawda123, for the helpful feedback which greatly improved both the software and manuscript.

A special thanks to @mikemahoney218 for being so prompt and helpful throughout this process!

fawda123 commented 1 month ago

@michaeldumelle happy to help, looking forward to seeing this in print!

michaeldumelle commented 1 month ago

@mikemahoney218, this paper came out yesterday, which details the formulation we have in the software for generalized linear models. Is it possible to add this citation (to the sentence in the paper where we currently talk about ssn_glm())? If you approve, I can make the change and push.

mikemahoney218 commented 1 month ago

That'll be fine -- if you can link the commit here so I can do a quick copy edit of your changes, that'd be ideal, but I don't see why we couldn't

michaeldumelle commented 1 month ago

Thanks so much @mikemahoney218 ; the relevant commit is linked here.

mikemahoney218 commented 1 month ago

Looks good to me! @openjournals/ese-eics will correct me if I'm wrong, but this should be ready for processing.

kthyng commented 1 month ago

Hi! I'll take over now as Track Associate Editor in Chief to do some final submission editing checks. After these checks are complete, I will publish your submission!

kthyng commented 1 month ago

@michaeldumelle

michaeldumelle commented 1 month ago

@kthyng done! link here. Thank you for catching that!

kthyng commented 1 month ago

Ok ready to go!

kthyng commented 1 month ago

@editorialbot accept

editorialbot commented 1 month ago
Doing it live! Attempting automated processing of paper acceptance...
editorialbot commented 1 month ago

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

``` cff-version: "1.2.0" authors: - family-names: Dumelle given-names: Michael orcid: "https://orcid.org/0000-0002-3393-5529" - family-names: Peterson given-names: Erin E. orcid: "https://orcid.org/0000-0003-2992-0372" - family-names: Hoef given-names: Jay M. Ver orcid: "https://orcid.org/0000-0003-4302-6895" - family-names: Pearse given-names: Alan orcid: "https://orcid.org/0000-0002-4133-8548" - family-names: Isaak given-names: Daniel J. doi: 10.5281/zenodo.12770259 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Dumelle given-names: Michael orcid: "https://orcid.org/0000-0002-3393-5529" - family-names: Peterson given-names: Erin E. orcid: "https://orcid.org/0000-0003-2992-0372" - family-names: Hoef given-names: Jay M. Ver orcid: "https://orcid.org/0000-0003-4302-6895" - family-names: Pearse given-names: Alan orcid: "https://orcid.org/0000-0002-4133-8548" - family-names: Isaak given-names: Daniel J. date-published: 2024-07-26 doi: 10.21105/joss.06389 issn: 2475-9066 issue: 99 journal: Journal of Open Source Software publisher: name: Open Journals start: 6389 title: "SSN2: The next generation of spatial stream network modeling in R" type: article url: "https://joss.theoj.org/papers/10.21105/joss.06389" volume: 9 title: "SSN2: The next generation of spatial stream network modeling in R" ```

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

editorialbot commented 1 month ago

🐘🐘🐘 πŸ‘‰ Toot for this paper πŸ‘ˆ 🐘🐘🐘

editorialbot commented 1 month ago

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/5686
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06389
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! πŸŽ‰πŸŒˆπŸ¦„πŸ’ƒπŸ‘»πŸ€˜

Any issues? Notify your editorial technical team...

kthyng commented 1 month ago

Congratulations on your new publication @michaeldumelle! Many thanks to @mikemahoney218 and to reviewers @fernandomayer, @k-doering-NOAA, and @fawda123 for your time, hard work, and expertise!! JOSS wouldn't be able to function nor succeed without your efforts.

@michaeldumelle If you'd like to review for JOSS, please register at https://reviewers.joss.theoj.org/.

editorialbot commented 1 month ago

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06389/status.svg)](https://doi.org/10.21105/joss.06389)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.06389">
  <img src="https://joss.theoj.org/papers/10.21105/joss.06389/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.06389/status.svg
   :target: https://doi.org/10.21105/joss.06389

This is how it will look in your documentation:

DOI

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

michaeldumelle commented 1 month ago

A final, huge thanks to @kthyng, @mikemahoney218, @fawda123, @k-doering-NOAA, and @fernandomayer for making this such an enriching process! Your hard work and feedback led me to adopt better software development practices that notably improved both the SSN2 software and the associated manuscript.