-
-
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]: HRnV-Calc: A Software for Heart Rate n-Variability and Heart Rate Variability Analysis #5391
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:
|
|
Wordcount for |
|
Review checklist for @smnnltConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hi @charlienew , here are some additional comments to my review: First of all thank you very much for providing this interesting piece of software. I think the GUI interface for HR(n)V analysis may be very helpful in practical settings and I look forward to future insights into the newly developed measurement parameters. In addition to the checklist above and the issues I opened in the repo I have some remarks regarding the software paper: Authorship: From what I can see, three of the ten authors listed on the paper have contributed code to the software. While it is ultimately your choice who to add as an author, please double-check that all other people have made non-code contributions specifically to this software (e.g., software testing, conceptualization). Summary: I appreciate your efforts in providing a well-referenced introduction to HR(n)V analysis in the introduction of your paper. Even for me as a sport scientist (though not working in the field of HRV research) it was indeed hard to follow the technical parts of this section. Please note, that the summary section of the paper should avoid jargon and be adressed to a non-specialist audience (https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain). Basic Usage: I believe this section could be much shorter. The quite detailed API walkthrough is mostly already part of your well-written README and should not be part of the JOSS paper. However I think that showing some high-level functionality of the software may also be useful in the paper, so I suggest to keep Figure 1 with the general workflow and to shortly mention important other features without going much into detail. This could also help you to archieve the target word count for the paper (<1000). Additionally, there are some references in this section related to specific processing options that should rather be part of the software documentation (i.e., the README in your case). |
Review checklist for @itismeghasyamConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Thank you @smnnlt and @itismeghasyam for reviewing our software and the constructive comments. To respond to the comments from @smnnlt, first of all, thank you for pointing out the concern for authorship. We know that the list might be longer than most papers on JOSS. However, we can confirm that all other authors listed have contributed to our software either in conceptualization or in testing. Although the code was only written by three people, the design and the workflow of HRnV-Calc are the results of wide collaboration between clinicians and HRV researchers. We understand that the introduction of our paper might be somewhat lengthy and exhaustive. However, we do think a bit of technical details is necessary since the HRnV method is quite new, and not many people are familiar with its background and the motives for its introduction. We believe most of the potential users of HRnV-Calc to be in the field of HRV and related research, in particular, clinicians dealing with cardiac-related conditions. Therefore, some in-depth descriptions and discussions of HRnV would help them to decide whether to try our software. However, we will work on the writing of this section to make it more appealing to a broader audience. The comments on the basic usage section are absolutely right. We will remove all the figures except Figure 1 and shorten the descriptions for each GUI. We will also address the issues raised in our HRnV-Calc repo and respond directly in the corresponding issue threads. Once all necessary changes are done, we will update our code and paper in the repo. Thanks again for your feedback and suggestions! |
@charlienew Thanks for your comments, and for confirming @smnnlt's comment on authorship - it clarified my doubts too. Can you please include a section in the README/documentation about how to contribute to the repository, and/or how issues are reported and handled? |
Hi @itismeghasyam, thanks for your suggestions. Yes, we will include a section in our README about contributing guidelines and a code of conduct, which should be completed by the end of this week or early next week along with some other issues raised by @smnnlt. |
Hi @smnnlt and @itismeghasyam, Thanks again for reviewing our software and paper. We have updated our code and GitHub page to address the valuable feedback and suggestions. For the issues raised on our GitHub page, we have addressed them individually in the issue thread and made necessary changes to our code to fix the issues. We have also revised our paper to shorten the ‘Basic Usage’ section, which now only includes Figure 1 and some brief descriptions of each GUI. Thank you. |
Thanks @itismeghasyam and @smnnlt for the reviews so far, and @charlienew for the updates. Reviewers: when you can, please look over the changes made in response to your reviews, and update your checklists as warranted. |
@editorialbot generate pdf |
Hi @charlienew, thank you for answering the issues raised and for revising the paper. @bmcfee If the level of technical details in the summary section of the paper is fine from an editorial perspective, I am happy to endorse publishing the software paper. I have completed my review and have therefore updated my checklist. |
@smnnlt yes, I think the level of technical detail here is in keeping with the expectations outlined in the submission guidelines: https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain |
@charlienew Thanks for the revisions, they look good to me :) @bmcfee I competed my review checklist and am happy with this paper getting published. |
@editorialbot generate pdf |
@editorialbot check references |
👋 @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#4266, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot generate post review checklist |
I'm sorry human, I don't understand that. You can see what commands I support by typing:
|
Post-Review Checklist for Editor and AuthorsAdditional Author Tasks After Review is Complete
Editor Tasks Prior to Acceptance
|
@bmcfee thanks for editing here. I recommend the new functionality |
Thanks @Kevin-Mattheus-Moerman - I knew that feature was coming, but somehow missed that it was now active. |
@charlienew can you check the above list of tick mark points? ☝️ In particular the archive title should match the paper title, and the license listed on your repository should match the archive listed license (currently says Other(Open) ).
|
Hi @Kevin-Mattheus-Moerman, thanks for your feedback. I have updated the bib file accordingly. The release we created was V1.0.0 on our GitHub repo, and the DOI for our Zenodo archive is 10.5281/zenodo.7963494. The title and the license for our archive have also been updated. Thanks. Additional Author Tasks After Review is Complete
|
@editorialbot set 10.5281/zenodo.7963493 as archive |
Done! archive is now 10.5281/zenodo.7963493 |
@editorialbot check references |
|
@editorialbot generate pdf |
@charlienew thanks that all looks good now. We are good to proceed. |
@editorialbot accept |
|
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
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. |
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
@charlienew et al. congratulations on this publication in JOSS! 🎉 Thanks for editing @bmcfee! And a special thanks to the reviewers: @smnnlt, @itismeghasyam ! |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: 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:
|
Hi @Kevin-Mattheus-Moerman, thanks for your help! Thanks again to @bmcfee for your editing feedback, and thank you @smnnlt and @itismeghasyam for reviewing our paper! |
Submitting author: @charlienew (Chenglin Niu)
Repository: https://github.com/nliulab/HRnV-Calc
Branch with paper.md (empty if default branch):
Version: v1.0.0
Editor: @bmcfee
Reviewers: @smnnlt, @itismeghasyam
Archive: 10.5281/zenodo.7963493
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
@smnnlt & @itismeghasyam, 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 @bmcfee 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 @smnnlt
📝 Checklist for @itismeghasyam
The text was updated successfully, but these errors were encountered: