-
-
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]: PhysioLabXR: A Python Platform for Real-Time, Multi-modal, Brain–Computer Interfaces and Extended Reality Experiments #5854
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 |
|
@mstimberg Thanks again for editing this submission. Could you check in with the reviewers to see how they are getting on? |
@Kevin-Mattheus-Moerman I will! |
👋 @lucask07, @nastaran62 How are looking things from your side, did you find time to look at the software/paper yet? Please be reminded that JOSS reviews can be iterative, i.e. feel free to open issues or comment here as soon as you come across concerns – there is no need to gather everything into a single review text as commonly done for traditional journals. In the same vein, please generate your checklist and feel free to tick boxes in your checklist whenever you are sure about them (the two in the beginning – conflict of interest and code of conduct – would be good first candidates 😉 ). Thank you for your time, and please let me know if anything about the process is unclear or if there is anything else I can do to help move things along 🙏 ! |
Hi @mstimberg, |
Review checklist for @lucask07Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hi @ApocalyVec, thanks for this nice work. The paper has a few references to 'real-time'. I consider this a 'performance' claim as per the checkbox above. Could you please elaborate in the paper on what is meant by real-time (milliseconds, microseconds as in an RTOS, etc.)? Further what has been done to verify the real-time performance? Second, the paper mentions closed-loop control: lines 26-27 "often involving closed-loop interaction systems". Has the software been set up to mediate a closed-loop configuration? If so what sensors and actuators were used and what latency did the software support? I post these comments here, rather than as an issue on the source repository, since each is very specific to the JOSS paper. |
@ApocalyVec a few paper grammar notes:
|
Could you please walk us through the checkbox for "Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item." I see an example dataset such as Eye fixation data and am not sure if this data is relevant to the policy and if it is relevant if the research complies with the JOSS policy. Fig. 2 of the manuscript also seems to have human subject data. Please help us understand need for compliance here as well. |
Hi @mstimberg, |
Review checklist for @nastaran62Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hi @ApocalyVec, did you have a chance to look at @lucask07 earlier comments? And could you please comment on whether the eye fixation data set is original, otherwise unpublished data that has been collected by the authors of this manuscript. |
👋 @nastaran62 how are things going, did you have a chance yet to work on the review of the software/manuscript? |
Hey @mstimberg, thanks for checking in with us, and thank you @lucask07 for the constructive feedback! My team and I are working on a comprehensive response addressing the issues you raised. We will get back to you by Thursday 10/25. |
@mstimberg I'm working on it. Hopefully, I will give my comments by the end of this week. Sorry for my delayed review. |
@ApocalyVec Thank you very much for your excellent work. I have some comments and questions as follows: Document: 2- I can't see any API reference in the documents (No document in the code). API documentation are very helpful in tutorials/examples. 3- This tutorial, "Building ERP Classifier based on EEG and Pupil Size" is not clear. paper: 1- It's better to keep the figures' captions short and explain them in the main body. Software: 2- It seems that LSL has been used for data recording from any sensor. If so, the system performance depends on the network and the other software for reading data from a sensor. Could you please make it more clear or discuss it? Installation |
Hi @lucask07, thank you for your review and constructive feedback, and I apologize it took a while to get back to you. To answer your questions, PhysioLabXR is a soft real-time system. On the main thread, the best case is when all data is pulled from the network/device buffer before new data becomes available. Otherwise, data will accumulate in their buffers, leading to deteriorating performance. Within PhysioLabXR, we do the following to get close to a smooth run time:
The actual runtime performance of PhysioLabXR varies depending on the specs of the host computer, other running tasks competing for CPU time, and the amount of data that the user is streaming. We added to the docs: benchmarks across data throughputs commonly found in physiological experiments as a de facto verification of the performance. https://physiolabxrdocs.readthedocs.io/en/latest/Benchmarks.html The metrics in the benchmarks measure the running frequencies of 1) visualization and 2) pull data. This is because these two subroutines sit at the two sides of the spectrum in terms of priority. The plotting is the lowest priority thread in PhysioLabXR because missing the deadline has the least impact on the system’s integrity (though it affects user experience). We hope including these benchmarks can give users a hint at what performance level they should expect given their experiment setup. |
@lucask07 @mstimberg Thanks for raising the concern about data policy from human subjects. Let me clarify what data is in the paper. We obtained consent before collecting the data, and it is deidentified in the form that is presented (the data shown in the paper was, in fact, contributed by one of the co-authors). All the procedures we carried out while developing the software are in accordance with the Declaration of Helsinki. |
Hey @lucask07 really appreciate catching these mistakes! Just pushed the fix, asking the bot to compile a new proof now! |
Merged. DOI for the Octopus Sensing is in the paper. @mstimberg Please let us know if we can help with other stuff. Thank you! |
@editorialbot set v1.1.1 as version |
Done! version is now v1.1.1 |
@editorialbot generate pdf |
All looks good to me now, handing over to the topic editor 🚀 |
@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#4893, then you can now move forward with accepting the submission by compiling again with the command |
@ApocalyVec As AEiC I will now help process this work for acceptance in JOSS. I have checked the paper, this review, your repository, and the archive link. Most seems in order. Below is one minor point that needs your attention.
|
@Kevin-Mattheus-Moerman Updated! See here
|
@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... |
@ApocalyVec Congratulations on this JOSS publication! Thanks for editing @mstimberg, and a special thanks to the reviewers: @lucask07, @nastaran62 !! |
🎉🎉🎉 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 @mstimberg, @lucask07, @nastaran62, and the JOSS team, We are thrilled to see "PhysioLabXR" published in JOSS! 🎉 We want to express our sincere gratitude to each of you for your invaluable contributions throughout the review process. @mstimberg @Kevin-Mattheus-Moerman for your guidance as the editor in shaping the final version of our paper. To @lucask07 and @nastaran62, for your thorough and insightful reviews were incredibly helpful for both the paper and the software! This collaborative effort has been a rewarding journey, and your support has been a significant part of its success. I'm looking forward to possibly crossing paths with y'all again in the future. Again, thank you all once for your time, expertise, and constructive feedback! Best regards, |
Submitting author: @ApocalyVec (Ziheng Li)
Repository: https://github.com/PhysioLabXR/PhysioLabXR
Branch with paper.md (empty if default branch): joss-paper
Version: v1.1.1
Editor: @mstimberg
Reviewers: @lucask07, @nastaran62
Archive: 10.5281/zenodo.10471500
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
@lucask07 & @nastaran62, 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 @mstimberg 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 @lucask07
📝 Checklist for @nastaran62
The text was updated successfully, but these errors were encountered: