[PRE REVIEW]: MNE-LSL: Real-time framework integrated with MNE-Python for online neuroscience research through LSL-compatible devices.

[editorialbot]

Submitting author: @mscheltienne (Mathieu Scheltienne)
Repository: https://github.com/mne-tools/mne-lsl
Branch with paper.md (empty if default branch):
Version: 1.5.0
Editor: Pending
Reviewers: Pending
Managing EiC: Kevin M. Moerman

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/ff89793e3cc280dfcf5b3c9005ca984f"><img src="https://joss.theoj.org/papers/ff89793e3cc280dfcf5b3c9005ca984f/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/ff89793e3cc280dfcf5b3c9005ca984f/status.svg)](https://joss.theoj.org/papers/ff89793e3cc280dfcf5b3c9005ca984f)

Author instructions

Thanks for submitting your paper to JOSS @mscheltienne. Currently, there isn't a JOSS editor assigned to your paper.

@mscheltienne if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, 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:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.17 s (1006.0 files/s, 148456.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         119           2996           6355          12627
SVG                              6             62              2           1088
YAML                            14             29              3            597
reStructuredText                23            234            262            317
TeX                              2             18              0            174
TOML                             1             18              0            167
Markdown                         2             25              0            145
DOS Batch                        1             10              3             43
make                             1             10              1             24
INI                              1              1              0             13
CSS                              1              1              0             10
-------------------------------------------------------------------------------
SUM:                           171           3404           6626          15205
-------------------------------------------------------------------------------

Commit count by author:

   699	Mathieu Scheltienne
   385	Arnaud Desvachez
   270	Kyuhwa Lee
    36	pre-commit-ci[bot]
    23	github-actions[bot]
    14	dnastars
     8	dependabot[bot]
     2	Eric Larson
     1	Daniel McCloy
     1	Quentin Uhl
     1	Toni M. Brotons
     1	Valeria de Seta
     1	Дим Щ

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 785

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.3389/fnins.2013.00267 is OK
- 10.1038/s41586-020-2649-2 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: BrainFlow is a library intended to obtain, parse a...
- No DOI given, and none found for title: LSL is an open-source networked middleware ecosyst...
- No DOI given, and none found for title: MNE-realtime: realtime analysis of MEG/EEG data wi...
- No DOI given, and none found for title: Neuromore Studio: Real-Time Biosignal Processing S...
- No DOI given, and none found for title: OpenBCI creates open-source tools for biosensing a...
- No DOI given, and none found for title: Python interface to the Lab Streaming Layer.

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[editorialbot]

Five most similar historical JOSS papers:

MNE-ICALabel: Automatically annotating ICA components with ICLabel in Python
Submitting author: @adam2392
Handling editor: @emdupre (Active)
Reviewers: @TomDonoghue, @adswa
Similarity score: 0.7620

MNELAB: a graphical user interface for MNE-Python
Submitting author: @cbrnr
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @vahid-sb, @tuliofalmeida
Similarity score: 0.7614

PyBCI: A Python Package for Brain-Computer Interface (BCI) Design
Submitting author: @lmbooth
Handling editor: @emdupre (Active)
Reviewers: @anilbey, @jsheunis
Similarity score: 0.7579

Pycrostates: a Python library to study EEG microstates
Submitting author: @vferat
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @AJQuinn, @vahid-sb, @tuliofalmeida, @anshu-97
Similarity score: 0.7544

Openseize: A digital signal processing package for large EEG datasets in Python
Submitting author: @mscaudill
Handling editor: @samhforbes (Active)
Reviewers: @szorowi1, @AJQuinn
Similarity score: 0.7457

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[Kevin-Mattheus-Moerman]

@mscheltienne Dear author, thanks for this submission. I am the AEiC on this track and here to help process the initial steps. Before we proceed, please can you have a look at the following points:

• Please study the above reference check ☝️ and see if you can address any of the reported potential DOI issues. You can add/amend DOI entries in your .bib file, and call @editorialbot check references here to check them again.
• Your project appears to lack contributing guidelines at the moment. Please work to add these and to mention/link to them in your README. You could for instance create a CONTRIBUTING.md file (see here for some examples: https://contributing.md/example/).
• In your affiliations, please spell out USA as United States of America.
• Can you please clarify if reviewers of this work would need particular hardware/devices to test the capabilities?

[Kevin-Mattheus-Moerman]

@editorialbot invite @sneakers-the-rat as editor

[editorialbot]

Invitation to edit this submission sent!

[mscheltienne]

@editorialbot commands

[editorialbot]

Hello @mscheltienne, here are the things you can ask me to do:

# List all available commands
@editorialbot commands

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for branch
@editorialbot set joss-paper as branch

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

# Check the references of the paper for missing DOIs
@editorialbot check references

# Generates the pdf paper
@editorialbot generate pdf

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Get a link to the complete list of reviewers
@editorialbot list reviewers

[mscheltienne]

@Kevin-Mattheus-Moerman Thank you for this initial checklist.

• DOIs: It looks correct to me, the SKIP DOIs entries don't have an associated DOIs that I could use.
• Contributing guidelines: I added the guidelines here Add contributing guide mne-tools/mne-lsl#332
  JOSS list the package version at 1.5.0, and I don't see an editorialbot command to edit the version. Can I cut a new 1.6.0 release including the contributing guidelines or would it cause an issue for the JOSS review?
• Spelling of USA: Fix affiliation: spell out USA mne-tools/mne-lsl#333
• Particular hardware/devices to review: Nothing extra is needed, all the tutorials and examples can be run as is and mne-lsl includes a mock object to test and develop projects locally without specific hardware. However, if a reviewer has access to an EEG (or other) device and to its LSL application, he is more than welcome to review with this device.

Looking at the potential reviewers, I can suggested:

• adswa
• AJQuinn
• anshu-97
• vahid-sb

[Kevin-Mattheus-Moerman]

@mscheltienne thanks for those changes. The handling editor can update the version tag later. We ask that you mint a new release at the end of the review and we'll use the version tag for that then. So there is no need to increase the version tag from our end at this point yet. But if you want to increment the version that is fine and the editor can update it at any point.

[Kevin-Mattheus-Moerman]

@editorialbot check references

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.3389/fnins.2013.00267 is OK
- 10.1038/s41586-020-2649-2 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: BrainFlow is a library intended to obtain, parse a...
- No DOI given, and none found for title: LSL is an open-source networked middleware ecosyst...
- No DOI given, and none found for title: MNE-realtime: realtime analysis of MEG/EEG data wi...
- No DOI given, and none found for title: Neuromore Studio: Real-Time Biosignal Processing S...
- No DOI given, and none found for title: OpenBCI creates open-source tools for biosensing a...
- No DOI given, and none found for title: Python interface to the Lab Streaming Layer.

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[mscheltienne]

@editorialbot generate pdf

[mscheltienne]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.17 s (1021.9 files/s, 149188.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         119           2996           6355          12627
SVG                              6             62              2           1088
YAML                            14             29              3            597
reStructuredText                25            283            304            387
TeX                              2             18              0            174
TOML                             1             18              0            167
Markdown                         3             26              0            151
DOS Batch                        1             10              3             43
make                             1             10              1             24
INI                              1              1              0             13
CSS                              1              1              0             10
-------------------------------------------------------------------------------
SUM:                           174           3454           6668          15281
-------------------------------------------------------------------------------

Commit count by author:

   705	Mathieu Scheltienne
   385	Arnaud Desvachez
   270	Kyuhwa Lee
    37	pre-commit-ci[bot]
    23	github-actions[bot]
    14	dnastars
     8	dependabot[bot]
     2	Eric Larson
     1	Daniel McCloy
     1	Quentin Uhl
     1	Toni M. Brotons
     1	Valeria de Seta
     1	Дим Щ

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 788

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[Kevin-Mattheus-Moerman]

@editorialbot invite @sneakers-the-rat as editor

[editorialbot]

Invitation to edit this submission sent!

[Kevin-Mattheus-Moerman]

@sneakers-the-rat 👋

[Kevin-Mattheus-Moerman]

@mscheltienne apologies for the delays encountered here looking for a handling editor. Unfortunately all editors in this domain are busy handling other submissions. If @sneakers-the-rat is unavailable I'll look for an alternative editor, but we may need to wait until one becomes available.

[mscheltienne]

Alright, thanks for the heads-up!