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

[REVIEW]: StormR: An R package to quantify and map the tropical storms and cyclones’ winds characteristics #5766

Closed
editorialbot opened this issue Aug 17, 2023 · 59 comments
Assignees
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 6 (ESE) Earth Sciences and Ecology

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Aug 17, 2023

Submitting author: @thomasarsouze (Thomas Arsouze)
Repository: https://github.com/umr-amap/StormR
Branch with paper.md (empty if default branch):
Version: v0.1.2
Editor: @hugoledoux
Reviewers: @gsapijaszko, @highamm
Archive: 10.5281/zenodo.10417763

Status

status

Status badge code:

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

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

@gsapijaszko & @highamm, 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 @hugoledoux 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 @highamm

📝 Checklist for @gsapijaszko

@editorialbot editorialbot added R review TeX Track: 6 (ESE) Earth Sciences and Ecology waitlisted Submissions in the JOSS backlog due to reduced service mode. labels Aug 17, 2023
@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.03 s (1204.2 files/s, 325159.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               18           1101           1990           4592
Markdown                         4            145              0            675
TeX                              1             26              0            351
YAML                             8             52             12            314
JSON                             1              0              0            117
Rmd                              6            170            642             74
-------------------------------------------------------------------------------
SUM:                            38           1494           2644           6123
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1147

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1579/0044-7447(2008)37[241:TVOCWF]2.0.CO;2 is OK
- 10.1038/s41467-019-09319-2 is OK
- 10.1016/j.rsma.2022.102207 is OK
- 10.1038/s41467-021-21777-1 is OK
- 10.1017/9781009157896.002 is OK
- 10.1073/pnas.1922500117 is OK
- 10.1080/00431672.1974.9931702 is OK
- 10.25921/82ty-9e16 is OK
- 10.1175/2009BAMS2755.1 is OK
- 10.1175/MWR3106.1 is OK
- 10.1002/j.1477-8696.1999.tb06435.x is OK
- 10.1038/nature03906 is OK
- 10.1080/00431672.1974.9931702 is OK
- 10.1890/02-4057 is OK
- 10.1890/0012-9615(2001)071[0027:LARIOH]2.0.CO;2 is OK
- 10.1175/MWR2831.1 is OK
- 10.1175/1520-0493(1980)108<1212:AAMOTW>2.0.CO;2 is OK
- 10.1175/1520-0469(1995)052<4501:NMIOBV>2.0.CO;2 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@highamm
Copy link

highamm commented Aug 18, 2023

Review checklist for @highamm

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/umr-amap/StormR?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@thomasarsouze) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@highamm
Copy link

highamm commented Aug 21, 2023

Hi @thomasarsouze,

Would you be able to add the code generating the images in Figure 2 in https://github.com/umr-amap/StormR/tree/master/paper/images (or, if I've missed the code generating that Figure, could you point me in the right direction?)

Thanks!
Matt

@highamm
Copy link

highamm commented Aug 21, 2023

Hi @thomasarsouze,

I've opened up an issue at umr-amap/StormR#68.

Thanks, and hope all is well!
Matt

@thomasarsouze
Copy link

Would you be able to add the code generating the images in Figure 2 in https://github.com/umr-amap/StormR/tree/master/paper/images (or, if I've missed the code generating that Figure, could you point me in the right direction?)

As stated in the caption of the figure, all plots were generated using plotStorms and plotBehaviour functions, and the code to produce them can be seen on this Spatial Behaviour article. However, they were gathered into one figure manualy.

@highamm
Copy link

highamm commented Aug 31, 2023

Hey @thomasarsouze, thanks for the info! Would it be possible to add a link to the Spatial Behaviour article you reference in the Figure caption itself so that people reading the article know where to go to reproduce the sub-figures easily?

@thomasarsouze
Copy link

Hey @thomasarsouze, thanks for the info! Would it be possible to add a link to the Spatial Behaviour article you reference in the Figure caption itself so that people reading the article know where to go to reproduce the sub-figures easily?

Done in commit f25bf7b

@highamm
Copy link

highamm commented Sep 1, 2023

Hello @thomasarsouze, can you add some community guidelines (clear guidelines for third parties wishing to 1. Contribute to the software, 2. Report issues or problems with the software, 3. Seek support) to the StormR repository README file?

Or, if these are given elsewhere, could you point me in the direction of where they are given? Thanks!

@thomasarsouze
Copy link

can you add some community guidelines (clear guidelines for third parties wishing to 1. Contribute to the software, 2. Report issues or problems with the software, 3. Seek support) to the StormR repository README file?

Indeed this is missing information.
Done in commit 38cb634

@gsapijaszko
Copy link

gsapijaszko commented Sep 5, 2023

Review checklist for @gsapijaszko

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/umr-amap/StormR?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@thomasarsouze) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)
  • Installation: Does installation proceed as outlined in the documentation?

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@kthyng kthyng removed the waitlisted Submissions in the JOSS backlog due to reduced service mode. label Oct 25, 2023
@kthyng
Copy link

kthyng commented Oct 25, 2023

Hi all! It looks like this review has grown stale. @gsapijaszko have you run across any issues in your review?

@gsapijaszko
Copy link

Hi,

I'm really sorry it took so long. Went through the review during the weekend, in my humble opinion, the paper is well written and can be published.

Regards,
Grzegorz

@hugoledoux
Copy link

Thanks @gsapijaszko for coming back to us.

You only mention the "paper", but JOSS is mostly about the code, the docs, and all the criteria as listed above. Can you let us know whether you installed the software and tested all the criteria? I am a bit confused by your wording here.

@thomasarsouze
Copy link

@hugoledoux & @kthyng : sorry to bother you, but is there anything we can do here to not let this review last too long ?

@kthyng
Copy link

kthyng commented Nov 20, 2023

@gsapijaszko Could you check in on this review please? See question above.

@thomasarsouze
Copy link

Hi.
It's been almost four months since submission, and I am not sure that the review process is still active.
Can you let us how to move on and finalize the review process ?
Sincerly

@kthyng
Copy link

kthyng commented Dec 13, 2023

@thomasarsouze I am sorry for the delay here. I have just emailed @gsapijaszko to see if we might hear back about their review to see about next steps. Thank you.

@gsapijaszko
Copy link

gsapijaszko commented Dec 15, 2023

Yes, I have installed and tested the software. Otherwise I wouldn't mark check marks in review. Yes, I went through examples/help and played with the data. All criteria are met. I don't have anything to complain about, neither paper, neither software.

Regards,
Grzegorz

@hugoledoux
Copy link

@editorialbot set 10.5281/zenodo.10417763 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.10417763

@hugoledoux
Copy link

@editorialbot set v0.1.2 as version

@hugoledoux
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1579/0044-7447(2008)37[241:TVOCWF]2.0.CO;2 is OK
- 10.1038/s41467-019-09319-2 is OK
- 10.1016/j.rsma.2022.102207 is OK
- 10.1038/s41467-021-21777-1 is OK
- 10.1017/9781009157896.002 is OK
- 10.1073/pnas.1922500117 is OK
- 10.1080/00431672.1974.9931702 is OK
- 10.25921/82ty-9e16 is OK
- 10.1175/2009BAMS2755.1 is OK
- 10.1175/MWR3106.1 is OK
- 10.1002/j.1477-8696.1999.tb06435.x is OK
- 10.1038/nature03906 is OK
- 10.1080/00431672.1974.9931702 is OK
- 10.1890/02-4057 is OK
- 10.1890/0012-9615(2001)071[0027:LARIOH]2.0.CO;2 is OK
- 10.1175/MWR2831.1 is OK
- 10.1175/1520-0493(1980)108<1212:AAMOTW>2.0.CO;2 is OK
- 10.1175/1520-0469(1995)052<4501:NMIOBV>2.0.CO;2 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@hugoledoux
Copy link

@thomasarsouze it took longer than what we wanted, but in the end it's accepted just in time for the winter holidays 🎄☃️

thanks to @gsapijaszko and @highamm !

@editorialbot
Copy link
Collaborator Author

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

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4863, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Dec 22, 2023
@kthyng
Copy link

kthyng commented Jan 2, 2024

My steps:

  • Check that version was updated
  • Check that software archive exists, has been input to JOSS, and title and author list look good
  • Check paper

@kthyng
Copy link

kthyng commented Jan 2, 2024

@editorialbot set v0.1.2 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v0.1.2

@kthyng
Copy link

kthyng commented Jan 2, 2024

Not sure why that didn't stick before...

@kthyng
Copy link

kthyng commented Jan 2, 2024

@thomasarsouze A JOSS review is usually a good time to bump to a nice round version number like v1.0.0 — but up to you.

@kthyng
Copy link

kthyng commented Jan 2, 2024

Paper edits: umr-amap/StormR#79

@thomasarsouze
Copy link

@kthyng thanks for your inputs, they have been merged.

A JOSS review is usually a good time to bump to a nice round version number like v1.0.0 — but up to you.

I prefer to stick to the current version, we have long-term developments that will later justify such a bump.

@kthyng
Copy link

kthyng commented Jan 11, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@kthyng
Copy link

kthyng commented Jan 11, 2024

Ok looks ready to go!

@kthyng
Copy link

kthyng commented Jan 11, 2024

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

Doing it live! Attempting automated processing of paper acceptance...

@editorialbot
Copy link
Collaborator Author

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: Delaporte
  given-names: Baptiste
- family-names: Arsouze
  given-names: Thomas
  orcid: "https://orcid.org/0000-0002-8871-6120"
- family-names: Keppel
  given-names: Gunnar
  orcid: "https://orcid.org/0000-0001-7092-6149"
- family-names: Jullien
  given-names: Swen
  orcid: "https://orcid.org/0000-0002-5389-0532"
- family-names: Menkes
  given-names: Christophe
  orcid: "https://orcid.org/0000-0002-1457-9696"
- family-names: Ibanez
  given-names: Thomas
  orcid: "https://orcid.org/0000-0002-3192-1721"
contact:
- family-names: Arsouze
  given-names: Thomas
  orcid: "https://orcid.org/0000-0002-8871-6120"
doi: 10.5281/zenodo.10417763
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Delaporte
    given-names: Baptiste
  - family-names: Arsouze
    given-names: Thomas
    orcid: "https://orcid.org/0000-0002-8871-6120"
  - family-names: Keppel
    given-names: Gunnar
    orcid: "https://orcid.org/0000-0001-7092-6149"
  - family-names: Jullien
    given-names: Swen
    orcid: "https://orcid.org/0000-0002-5389-0532"
  - family-names: Menkes
    given-names: Christophe
    orcid: "https://orcid.org/0000-0002-1457-9696"
  - family-names: Ibanez
    given-names: Thomas
    orcid: "https://orcid.org/0000-0002-3192-1721"
  date-published: 2024-01-11
  doi: 10.21105/joss.05766
  issn: 2475-9066
  issue: 93
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5766
  title: "StormR: An R package to quantify and map the tropical storms
    and cyclones' winds characteristics"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05766"
  volume: 9
title: "StormR: An R package to quantify and map the tropical storms and
  cyclones' winds characteristics"

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
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 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 👉 Creating pull request for 10.21105.joss.05766 joss-papers#4896
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05766
  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...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Jan 11, 2024
@kthyng
Copy link

kthyng commented Jan 11, 2024

Congrats on your new publication @thomasarsouze! Many thanks to editor @hugoledoux and reviewers @gsapijaszko and @highamm for your time, hard work, and expertise!!

@kthyng kthyng closed this as completed Jan 11, 2024
@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

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.05766/status.svg)](https://doi.org/10.21105/joss.05766)

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

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

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 6 (ESE) Earth Sciences and Ecology
Projects
None yet
Development

No branches or pull requests

6 participants