-
-
Notifications
You must be signed in to change notification settings - Fork 36
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]: Frites: A Python package for functional connectivity analysis and group-level statistics of neurophysiological data #3842
Comments
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @madvn, @travisbthomp it looks like you're currently assigned to review this paper 🎉. Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post. ⭐ Important ⭐ If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿 To fix this do the following two things:
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:
|
PDF failed to compile for issue #3842 with the following error:
|
|
👋🏼 @EtienneCmb @madvn @travisbthomp this is the review thread for the paper. All of our communications will happen here from now on. Both reviewers have checklists at the top of this thread with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also 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. Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package. We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. Also note that the current paper is in the branch 'paper', so use e.g. -> @whedon generate pdf from branch paper Please feel free to ping me (@meg-simula ) if you have any questions/concerns. |
@whedon generate pdf from branch paper |
|
@whedon check references from branch paper |
|
|
We checked the 3 MISSING DOIs on https://dx.doi.org/ and they all appear to be correct. |
👋 @travisbthomp, please update us on how your review is going (this is an automated reminder). |
👋 @madvn, please update us on how your review is going (this is an automated reminder). |
Sorry about the delay, I will get to it this weekend. |
Getting around to this now with other deadlines mostly behind me. |
@EtienneCmb I am running some of the examples from the documentation. I noticed the following (likely unintentional) output from plot_stim_spec_network.py plot_stim_spec_network.py:211: SyntaxWarning: "is" with a literal. Did you mean "=="? |
All Issues in this comment have now been addressed. Nov 29, 2021Resolution: Updated to frites 0.4.1 and re-checked the scripts below
Traceback (most recent call last):
Traceback (most recent call last):
Update note: removed some other comments regarding plot mismatches as I noticed the data was generated using random values. |
Hello all, I am just getting to this as well. Sorry about the delay. Looks like a very interesting toolbox. I think the idea of feature-specific functional networks using mutual information can be used widely in not just neuroscientific settings but also sociology or even, more topically, epidemiology. I've updated my checklist based on a quick look at the repo and installing the package. I also took a quick look at the paper and have some notes for the authors based on the following requirements while I work my way through the rest of the checklist.
You have a summary but please revise it to address the "for a diverse, non-specialist audience" part of the requirement. Add a note about the breadth of usability of these tools in other domains besides neuroscience.
Please place your tool in the space of other information theory tools such as
Please update references based on additional paper that you will cite to address the above points. |
Dear @travisbthomp,
I fixed this morning the warning message by replacing 'is' with '=='
Indeed, as you saw, we are mainly using random data for illustrating the functions
Indeed, both examples were using the develop branch. This morning I pushed the version 0.4.1 of Frites to Pypi, it should works now once updated. |
@whedon generate pdf from branch paper |
|
Suggestions for paperAfter reviewing the paper I would like to make a few comments in the spirit of the review guidelines above. SummaryHas a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?The description of the high level functionality is not quite clear. "Frites provides such an integrated framework" for what? Is Frites limited to "discovery of cognitive brain networks from multi-channel neurophysiological datasets"? What types of networks? Conversely, I think that the documentation text is quite approachable and nice!
In short, the current summary seems obfuscated and potentially difficult to read for a "non-specialist audience". Statement of needDoes the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?The paper does indeed have a section titled 'Statement of Need'. However, this section does not establish a clear need for the software nor does it "clearly state what problems the software is designed to solve and who the target audience is". At least, it does not do these things in a way that can be appreciated by an non-expert in the area, such as myself, who is not currently aware of the state of the art approaches, what problems they could solve better, and why Frites fills any of these gaps. I would suggest revisiting this write up with the journal guidelines in mind. State of the fieldDo the authors describe how this software compares to other commonly-used packages?I cannot find where this has been done in a manner that is decipherable to a non-expert. I would suggest an approach which clearly states the central problem Frites aims to solve and endeavors a comparative discussion to other available tools; what are the advantages of Frites over other packages? If there are no other packages, simply state that Frites is the first of its kind. Quality of writingIs the paper well written (i.e., it does not require editing for structure, language, or writing quality)?The authors do not struggle with the tenets of structural composition. The central message of the statement of need is not currently clear, but this is not an issue with the sentence-by-sentence structure/language/quality per se. ReferencesIs 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?I did not see any issues with the references and all provided DOI links correct redirected to the appropriate paper. |
👋 @openjournals/sbcs-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#3676, then you can now move forward with accepting the submission by compiling again with the command |
@meg-simula I checked the final proof, everything seems correct :) |
Great! Now, we are just waiting for one of editors-in-chief to take a look at it - no need to take further action from your side. |
@editorialbot recommend-accept |
|
|
👋 @openjournals/sbcs-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#3696, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot recommend-accept |
|
👋 @openjournals/sbcs-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#3698, then you can now move forward with accepting the submission by compiling again with the command |
|
@editorialbot recommend-accept |
1 similar comment
@editorialbot recommend-accept |
|
👋 @openjournals/sbcs-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#3713, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
|
🐦🐦🐦 👉 Tweet 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... |
@EtienneCmb yay! congratulations! 🎉 Big thanks to @meg-simula for editing and the reviewers: @madvn, @travisbthomp! ❤️ |
🎉🎉🎉 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:
|
Great, thank you @oliviaguest and @meg-simula . Many thanks to the reviewers @madvn and @travisbthomp :) |
@EtienneCmb , quick note, (maybe you've already planned this) you could put the pdf from here on arxiv for more visibility if you want. |
Submitting author: @EtienneCmb (Etienne Combrisson)
Repository: https://github.com/brainets/frites
Branch with paper.md (empty if default branch): paper
Version: v0.4.3
Editor: @meg-simula
Reviewers: @madvn, @travisbthomp
Archive: 10.5281/zenodo.7278278
Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.
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
@madvn & @travisbthomp, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @meg-simula 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 ✨
Review checklist for @madvn
✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @travisbthomp
✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
The text was updated successfully, but these errors were encountered: