-
-
Notifications
You must be signed in to change notification settings - Fork 38
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]: KielMAT: Kiel Motion Analysis Toolbox - An Open-Source Python Toolbox for Analyzing Neurological Motion Data from Various Recording Modalities #6842
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: |
|
@aaa34169, @davidpagnon thanks for agreeing to review this submission. This is where the review takes place. Please get started by calling |
Review checklist for @aaa34169Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @davidpagnonConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
No worries 😄 I will delete our comments as well |
Most of the example files not available --> neurogeriatricskiel/KielMAT#90 |
Here is a first pass for the review: General checks
Functionality
Documentation
Software paper
|
@aaa34169 I hope you are doing well. Could you provide an update on where things stand? If you need more time let us know. Thanks again for your help! |
@JuliusWelzel apologies for the delay with this review so far. We'll see if we here from @aaa34169, if they are still able to help we'll resume, if not we'll try to find an alternative reviewer. |
Thanks @davidpagnon for your comprehensive review.
Examples for ICD and GSD have been added as part of #102. They can be simply loaded as shown in this example.
This has been added in neurogeriatricskiel/KielMAT@8fa81ad
A table with an overview has been added on the landing page in
We have added a link and statement about contributing in the README.
We have updated the summary in neurogeriatricskiel/KielMAT@a62e731
We have updated the text in various commits to address these valuable comments
We thank you for pointing this out. We have change the name of the toolbox to KielMotionAnalysisToolbox (KielMAT).
We adapted the text in the following commit: neurogeriatricskiel/KielMAT@d8f471f |
@Kevin-Mattheus-Moerman We made a new release as parts of our responses to @davidpagnon. The available version is now 0.0.5. |
Thanks for addressing my points! I tried all the modules with the new version and they all work seamlessly. Three last remarks:
|
Hi, thanks for getting back so quickly. All three points have been addressed as follows:
We set the progressbar
Good point, we now allow the data for the example to be downloaded form the online repo directly in: d79baaa419fa487ece3f0bbc3514817a07375075
Agreed, we moved it up on the main page in: 3a001628f85c50405528c78cf5739f574d9c4c92 |
It all looks good to me! |
Amazing, thank you for your valuable comments :) |
@aaa34169 I hope you are doing well. Could you provide an update on where things stand? If you need more time let us know. Thanks again for your help! |
yes, i recovered from my two broken arms :-) . I think i can do the review by the end of the week. |
@aaa34169 good to hear you recovered. Sounds like quite the trauma you went through. Thanks for still being willing to help, greatly appreciated! Looking forward to your contribution! |
here is my review of NGMT: NeuroGeriatric Motion Toolbox - An Open-Source Python Toolbox for Analyzing Neurological Motion Data from Various Recording Modalities General NGMT is implemented in Python (>=3.10) and is available under the Non-Profit Open Software License version 3.0. It can be installed from PyPI or from source on GitHub. The documentation includes comprehensive installation instructions, a conceptual framework, and tutorial notebooks. The code utilizes downloadable data from sources such as the Mobilised and OpenNeuro projects. However, it is important to note that these downloads may encounter SSL errors when accessed from a secure network, such as that of a hospital. Functionality The library is easily installable with Python 3.10. The local installation using the command
works flawlessly. The modules serve well-defined purposes. The library employs data from projects such as Mobilised or OpenNeuro. However, when accessed on a secure network, an "SSLCertVerificationError" exception may be returned. It would be beneficial to mention this potential error and ideally provide information on how to resolve or circumvent it. Regarding the data, I have also noted that the file "exAccelDataMobilise.csv" does not allow the example modules_03_pam to run successfully. Documentation The entirety of the library is documented and accessible . To address common errors, I would recommend that the authors create a "Common Issues" or "Frequently Asked Questions" section. In general, the documentation is intuitive and provides both high-level and low-level information. However, I find that the organization could be improved, particularly with a focus on the concept of DataClass and its usage. First, I suggest that the horizontal menu place DataClass before modules. Additionally, on the Home page, it is pertinent to describe the "KielMATRecording" object thoroughly, accompanied specifically by an explanation demonstrating how to construct a KielMATRecording instance from the user’s own data, rather than from the Mobilised project dataset. Moreover, on the Home page, the link https://neurogeriatricskiel.github.io/KielMAT/examples/00_tutorial_basics/ leads to a page with display errors. In the Examples section, I find the title "Tutorial basics" to be somewhat misleading, as the content of this page explains how to load a dataset and does not explore the modules. I would propose the following organization for the examples:
This reorganization would better reflect the content and provide clearer guidance for users. Paper My major comment concerns the term "performance" as cited by the authors: "...a new dimension of measuring daily function, that is performance." Performance is implicitly related to the International Classification of Functioning, Disability and Health (ICF). I believe the authors should explicitly reference the ICF in the manuscript. I also find no information in the "state of need" section regarding the four modules integrated into the library. Minor Comments
|
@aaa34169 thanks for this detailed review! |
@Kevin-Mattheus-Moerman Thanks, we will address them ASAP! |
All correct
We made the release 0.0.5 for the review of JOSS (also see PR102)
Sourcecode has been archived on OSF with the following DOI: 10.17605/OSF.IO/8M2SP
They match
It is the same LICENSE file Let us know if there is anything we can help with :) |
@editorialbot set version to v0.0.5 |
I'm sorry human, I don't understand that. You can see what commands I support by typing:
|
@editorialbot set v0.0.5 as version |
Done! version is now v0.0.5 |
@editorialbot set 10.17605/OSF.IO/8M2SP as archive |
Done! archive is now 10.17605/OSF.IO/8M2SP |
@JuliusWelzel sorry for the delay. I am just checking with some colleagues about the OSF archive. We usually handle ZENODO archives mostly, so I am just checking we are all happy with the OSF link. I'd say it should be fine but it doesn't render the things we usually look for in the same way. |
no worries. If you need pointers where to find specific details, I am glad to help. Best |
@JuliusWelzel The OSF link can be acceptable. But can you ensure all authors are listed, trust the license matches your software license and that the version tag is mentioned? You may need to use the description field to mention the version tag. |
Hi @Kevin-Mattheus-Moerman, thanks for your feedback on the OSF archive. The authors are listed in the projects wiki under authors at the end of the document. The wiki also references the version number. The version number also can be found in the projects metadata under description. The licence file is the same as on GH. I hope that resolves all issues. |
@Kevin-Mattheus-Moerman If there is anything else we can help move it over the finish line, please let us know. :) |
@JuliusWelzel thanks for the judge. No I think we are all set. I'll try to wrap this up now. |
@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#5952, then you can now move forward with accepting the submission by compiling again with the command |
@JuliusWelzel as AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I will now process some final checks: Checks on repository
Checks on review issue
Checks on archive
Checks on paper
|
@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. |
🐘🐘🐘 👉 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... |
@JuliusWelzel once again congratulations on this publication! I'd like to send a special thank you to the reviewers: @aaa34169, @davidpagnon !! |
🎉🎉🎉 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:
|
Submitting author: @JuliusWelzel (Julius Welzel)
Repository: https://github.com/neurogeriatricskiel/NGMT
Branch with paper.md (empty if default branch):
Version: v0.0.5
Editor: @Kevin-Mattheus-Moerman
Reviewers: @aaa34169, @davidpagnon
Archive: 10.17605/OSF.IO/8M2SP
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
@aaa34169 & @davidpagnon, 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 @Kevin-Mattheus-Moerman 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 @aaa34169
📝 Checklist for @davidpagnon
The text was updated successfully, but these errors were encountered: