-
-
Notifications
You must be signed in to change notification settings - Fork 39
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]: ssdtools v2: An R package to fit Species Sensitivity Distributions #7492
Comments
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:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
Software report:
Commit count by author:
|
Paper file info: 📄 Wordcount for ✅ The paper includes a |
License info: ✅ License found: |
|
👋🏼 @joethorley @flor14 @nanhung this is the review thread for the paper. All of our communications will happen here from now on. As a reviewer, the first step is to create a checklist for your review by entering
as the top of a new comment in this thread. These checklists contain the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. The first comment in this thread also contains links to the JOSS reviewer guidelines. The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. We can also use EditorialBot (our bot) to set automatic reminders if you know you'll be away for a known period of time. Please feel free to ping me (@fabian-s) if you have any questions/concerns. |
@joethorley while we wait for the reviews, could you check the "missing DOIs" the bot found in the comment above and add them to your refs if they are correct? |
Review checklist for @flor14Conflict of interest
Code of Conduct
General checks
Functionality
The documentation is complete and detailed. I received this message when I tried to download the package from CRAN.
Documentation
Software paper
|
@fabian-s I've added the two missing DOIs. |
@editorialbot generate pdf |
Review checklist for @nanhungConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@fabian-s One aspect I’ve always appreciated about JOSS papers is that they provide insights into aspects of the software not covered in other sections of the documentation. Since this is the second article for ssdtools, I found myself considering what additional information could be included, especially given that there is already an existing article for this software. For a manuscript's second version, it could be valuable to include examples addressing changes in functions that result in breaking changes. Also, requesting a more detailed explanation of the reasons and the impacts of changes in dependencies could be informative in some cases. I understand that this may go beyond the scope of this review as the process is now, so I focused on the points outlined in the checklist. Probably, you have already considered this when deciding to allow the publication of new versions and have taken these factors into account. I wanted to mention it since it influenced the comments I made in my review. @joethorley Only two points of the review have not been marked as resolved. I added notes on a few other points, but there are suggestions or comments that I don't consider to affect the quality of the software/manuscript. I believe these are "stylistic" considerations that are up to you, so I marked them as solved. |
@flor14 thank you so much for your timely, constructive and detailed review -- this is great! I second your recommendations, with one exception. i.e. "It might be helpful to organize the Technical Details section to indicate which changes were introduced in the first major version update and which were added in the second one." -- this level of historical detail seems less relevant to me, since the new paper is supposed to document the current state of the software. |
Thank you, @fabian-s, for your kind words and for reading my comments. You're right. Sometimes I like to include more detailed ways of organizing text to make the information more accessible to readers. I acknowledge that perhaps it wasn’t the best example. Either way, it’s one of the points the review marked as complete. Thank you for your feedback, and have a great weekend! |
I just completed my review of the package. It is well-developed, actively maintained, and widely adopted in recent publications, which speaks to its reliability and usefulness. One potential enhancement would be adding a comprehensive set of examples to simplify variable manipulation for users. Detailed comments are listed below:
I will open PR if I find any bug that can be simply fixed. Overall, nice package with a lot of refinements! |
@joethorley both reviewers make a number of suggestions to improve the paper/the software that seem very sensible to me. |
Thanks @flor14, @nanhung and @fabian-s, Myself and my co-authors appreciate the quick turn around, useful comments/suggestions and kind words. We are planning to address the comments/suggestions in the next two weeks ie by the 10th of December. We will likely use a combination of issues and comments in the thread. |
We think we have addressed all your comments/suggestions. We are just doing a final read through of the paper, getting the package ready for a CRAN release (v2.2.0) and ensuring it is compatible with shinyssdtools before provide a formal response to all your comments/suggestions. Thanks for your patience. |
ThanksThanks for everyone comments and suggestions. Below are your comments with our response. I added the tick box to indicate that we had responded to the comment. Hopefully our changes and responses are adequate. First Reviewer
Second Reviewer
Moving forward |
@editorialbot generate pdf |
thank you @joethorley for this structured and prompt response! @flor14 @nanhung |
@joethorley The vignettes are very clear and complete. There is just a small detail left in this log-normal distribution (I am checking the |
If this issue I mentioned about the log-normal is resolved, the review is complete for me. I’ve already checked the other points. |
@nanhung |
@fabian-s |
@fabian-s - I am currently in the process of updating on the main branch to update the website and submitting the lastest version to CRAN. This may take a week to 10 days as I need approval to update the main branch on the bcgov site but the approver is on vacation. Once this is complete I'll let you know and the paper should be ready for finalization. Thanks everyone! |
Post-Review Checklist for Editor and AuthorsAdditional Author Tasks After Review is Complete
Editor Tasks Prior to Acceptance
|
@flor14 - the formulas are all fixed on the website |
@editorialbot generate pdf |
@joethorley I have no further comments/corrections re. the text of the paper, please finalize the submission once the CRAN submission is done, see the "Additional Author Tasks " above. |
The release version number which is now on CRAN is v2.2.0 https://cran.r-project.org/web/packages/ssdtools/index.html The DOI for the Zenodo release is https://doi.org/10.5281/zenodo.14609128 I've done all the other checks. @fabian-s - Let us know if you need anything else and thanks for your patience. |
@editorialbot set 10.5281/zenodo.14609128 as archive |
Done! archive is now 10.5281/zenodo.14609128 |
@editorialbot set v2.2.0 as version |
Done! version is now v2.2.0 |
@editorialbot recommend-accept |
|
|
👋 @openjournals/bcm-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#6338, then you can now move forward with accepting the submission by compiling again with the command |
Submitting author: @joethorley (Joseph Thorley)
Repository: https://github.com/bcgov/ssdtools
Branch with paper.md (empty if default branch): joss-paper
Version: v2.2.0
Editor: @fabian-s
Reviewers: @flor14, @nanhung
Archive: 10.5281/zenodo.14609128
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
@flor14 & @nanhung, 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 @fabian-s 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 @flor14
📝 Checklist for @nanhung
The text was updated successfully, but these errors were encountered: