-
-
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]: Systems Neuro Browser (SNUB) #6187
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 |
|
👋 Hi @niksirbi, @vigji, @lucasmiranda42, and thank you again for agreeing to review this submission for SNUB! The review will take place in this issue, and you can generate your individual reviewer checklists by asking editorialbot directly with In working through the checklist, you're likely to have specific feedback on SNUB. Whenever possible, please open relevant issues on the linked software repository (and cross-link them with this issue) rather than discussing them here. This helps to make sure that feedback is translated into actionable items to improve the software ! If you aren't sure how to get started, please see the Reviewing for JOSS guide -- and, of course, feel free to ping me with any questions ! |
Review checklist for @lucasmiranda42Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @niksirbiConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @vigjiConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@emdupre I believe I have now responded to all the github issues raised by the reviewers. There are a number of checklist items where one or more reviewer left the item unchecked but did not raise a corresponding issue. Is there a process for seeking additional feedback on these points and/or offering a rebuttal? Thanks! |
Hi @calebweinreb, I saw you've been busy addressing many of the issues @vigji raised, which is great! On my side, I still need some time to finalise my review. I expect to raise some more issues today and tomorrow, sorry for the delay. |
Hi @calebweinreb, I believe you addressed all the issues I had - I will revise everything and close issues while I go through it - hopefully by this week! |
👋 Hi @calebweinreb, thanks for checking in on this !
Apologies if this was unclear : we had extended a month review window for this work, so we're still within that initial review period. It's great, though, that you're addressing issues as they're raised ! This helps to make the whole process faster, and I certainly appreciate seeing the progress there. @niksirbi @vigji and @lucasmiranda42, thank you again for your input to date on SNUB ! Please do let us know once you've finished your initial review, so we can make sure that your comments are fully considered. And of course, please don't hesitate to ping in this issue if you have any other questions ! |
Thank you everyone for the updates! |
Overall I think SNUB is a great tool. Something like it is needed in systems neuroscience, as more and more researchers acquire multiple synchronized data streams from the same animal. SNUB's primary purpose - as stated - is data exploration and visualisation and it achieves this goal very well. I was able to install SNUB and reproduce the tutorials using the provided sample data. I found the GUI to be performant and responsive, at least on my M2 Macbook. I think SNUB has the potential for wider adoption especially if the installation issues are addressed and if the data loading is made smoother (see individual issues below). In the following list I've included both issues raised by me and issues raised by other reviewers that I agree with. I consider the ones marked as @calebweinreb has already made inroads on addressing the major issues, so I'm confident that they will be solved. I'll happily recommend SNUB for publication in JOSS once the major issues are closed. Installation
Hiccups during installation can discourage new users and it's a shame if they miss out on SNUB because of them. The major issues should be resolved, or at least, the supported OS platforms (and versions thereof) should be indicated. @calebweinreb has already started working on making installation easier, e.g. by publishing the package on PyPI. Data loading
I think that making data loading as seamless as possible for the users will be critical for the project's long-term success. @calebweinreb has already made a big improvement by adding support for converting NWB files, as @vigji suggested. Maintainability and community
@calebweinreb seems to be the only active developer on the project. It would be useful to clarify to what extent contributions from others are welcome and what is the recommended process. If others start contributing to SNUB, issues like testing and linting will become increasingly important. Some tests have been already introduced, which is great 🎉 ! Although I haven't opened an issue about Continuous Integration, I would highly recommend adopting some sort of CI framework (e.g. GitHub actions) for automating tests on multiple OS platforms, which would also help catch the aforementioned installation problems. Miscellaneous
Thanks @emdupre for tagging me as a reviewer! It's a pleasure to review for JOSS. |
Thank you very much for your write-up, @niksirbi ! I appreciate this summary 🙏 @vigji and @lucasmiranda42, please let us know when you've finalized your reviews -- or if there are any blockers that we should be aware of ! And thank you again for your work on reviewing SNUB to date 🌻 |
👋 Hi everyone, happy Monday ! Just checking in on the status of this, @vigji and @lucasmiranda42. Please let me know if you have any current blockers (other than time !), or if there's anything I can do to help in this process. Thank you ! |
Hi @emdupre ! I have updated the status of my checklist based on the current state of the package. Overall, I agree with @niksirbi on SNUB being a useful resource (it was actually already in use in my lab before the submission, so I am sure about the potential!). I am not aware of other tools that it compares to, and I believe that it fills a gap in providing seamless visualizations for multi-modality time series data. I think that the scope and statement of need for the package are described with enough details in the paper. It is missing a session on comparison with other tools, but I am not aware of any so I do not have issues with that. I do think that @calebweinreb implemented most of the changes that I was considering major for publication. There is now a version of testing that can be used for a cursory check on functionality by contributors, and nice use cases for DANDI datasets that will definitively highlight how flexibly the package could be used to explore the user' own data or even existing open access datasets. There are still some minor changes and further improvements that can be done on the data input ( #calebweinreb/SNUB#12) and interface's side (#22), but I do not consider those blocking issues. Blocking issues:
Once those are addressed, this is good for publication on my side! |
Thank you, @vigji ! I assume you meant to link to calebweinreb/SNUB#20 and calebweinreb/SNUB#21, rather than the listed JOSS issues 😸 I will continue to track those and am looking forward to updates. Thank you again both for this summary and for your expertise in reviewing SNUB ! |
Hi, @emdupre, hi all! I should be able to update my review and raise some issues during the weekend. Best! |
Thank you for the update, @lucasmiranda42 ! I'll put in an EditorialBot reminder for later this week to make sure all relevant issues are cross-linked. Thank you again for agreeing to review SNUB ! |
@editorialbot remind @lucasmiranda42 in three days |
Reminder set for @lucasmiranda42 in three days |
I updated the version number and license and the DOI appears not to have changed. (link for convenience: https://zenodo.org/records/10825136) |
@editorialbot set 10.5281/zenodo.10825136 as archive |
Done! archive is now 10.5281/zenodo.10825136 |
@editorialbot generate pdf |
@editorialbot set 0.1.0 as version |
Done! version is now 0.1.0 |
Thank you, @calebweinreb ! I'm now happy to recommend SNUB to the EiC team for publication in JOSS ✨🚀 Thank you, too, to @vigji, @niksirbi, and @lucasmiranda42 for your reviews ! JOSS works because of your work 💐 |
@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#5166, then you can now move forward with accepting the submission by compiling again with the command |
Great! Thanks for all your help! |
@calebweinreb as AEiC for JOSS I will now help to process this submission for acceptance in JOSS. I have checked this review, your repository, the archive link, and the paper. Everything seems in order, there is only the following minor point that requires your attention:
@vigji and @lucasmiranda42, some of boxes remain unticked. If you feel these should be ticked please do so. Relating to the unticked boxes, from inspecting this review and the repository/paper I can see that:
|
@Kevin-Mattheus-Moerman thanks for pointing that out! I updated the affiliation to "Harvard Medical School" |
@Kevin-Mattheus-Moerman all ticked now! |
@editorialbot generate pdf |
@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... |
@calebweinreb congratulations on this JOSS publication! @emdupre thanks for editing! And a special thanks to the reviewers: @niksirbi, @vigji, @lucasmiranda42 !!! |
🎉🎉🎉 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:
|
Thank you everyone!! This was an awesome review experience. |
Submitting author: @calebweinreb (Caleb Weinreb)
Repository: https://github.com/calebweinreb/SNUB
Branch with paper.md (empty if default branch):
Version: 0.1.0
Editor: @emdupre
Reviewers: @niksirbi, @vigji, @lucasmiranda42
Archive: 10.5281/zenodo.10825136
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
@niksirbi & @vigji & @lucasmiranda42, 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 @emdupre 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 @niksirbi
📝 Checklist for @lucasmiranda42
📝 Checklist for @vigji
The text was updated successfully, but these errors were encountered: