[PRE REVIEW]: SleepECG: a Python package for sleep staging based on heart rate

[editorialbot]

Submitting author: !--author-handle-->@cbrnr<!--end-author-handle-- (Clemens Brunner) Repository: https://github.com/cbrnr/sleepecg Branch with paper.md (empty if default branch): joss Version: v0.5.4 Editor: !--editor-->@emdupre<!--end-editor-- Reviewers: @tompollard, @richrobe, @peterakirk Managing EiC: Kevin M. Moerman

Status

Status badge code:

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

Author instructions

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

@cbrnr if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission (please start at the bottom of the list).

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]

Checking the BibTeX entries failed with the following error:

Failed to parse BibTeX on value "--266" (NAME) ["@", #<BibTeX::Entry >, {:author=>["Agnew Jr., H. W. and Webb, W. B. Webb and Williams, R. L."], :title=>["{The first night effect: an EEG study of sleep}"], :journal=>["Psychophysiology"], :volume=>"2", :number=>"3", :year=>"1966", :pages=>"263"}]

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.88  T=0.12 s (622.8 files/s, 209925.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
SVG                              8              0            109          17772
Python                          32            901           1611           3377
Markdown                        19            189              0            601
C                                1             67            134            360
YAML                             8             40              4            280
HTML                             3              0              0             55
TeX                              1              5              0             48
TOML                             1             12              0             24
JavaScript                       1              2              0             15
CSS                              2              1              0             10
-------------------------------------------------------------------------------
SUM:                            76           1217           1858          22542
-------------------------------------------------------------------------------

gitinspector failed to run statistical information for the repository

[editorialbot]

Wordcount for paper.md is 720

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[Kevin-Mattheus-Moerman]

@editorialbot invite @emdupre as editor

[editorialbot]

Invitation to edit this submission sent!

[emdupre]

🙋‍♀️ I'll take this as well. Thanks for the invitation, @Kevin-Mattheus-Moerman !

[emdupre]

@editorialbot assign @emdupre as editor

[editorialbot]

Assigned! @emdupre is now the editor

[emdupre]

👋 Hi @cbrnr, and thanks for your submission to JOSS !

If you have suggestions for potential reviewers, please let me know by listing their names or GitHub handles (without the @, so they don't receive a notification) here.

You can suggest reviewers from any relevant project, though we often recommend starting with this database of people who have already agreed to review for JOSS.

I'll put together a list of folks to reach out to as reviewers based on these suggestions and my own recommendations. I'll update this thread with that outreach.

[emdupre]

Could you please also update your associated BibTeX file ? Currently compilation is returning the following error:

Failed to parse BibTeX on value "--266" (NAME) ["@", #<BibTeX::Entry >, {:author=>["Agnew Jr., H. W. and Webb, W. B. Webb and Williams, R. L."], :title=>["{The first night effect: an EEG study of sleep}"], :journal=>["Psychophysiology"], :volume=>"2", :number=>"3", :year=>"1966", :pages=>"263"}]

You can fix this by enclosing the ranges in all pages field entries in curly brackets or double-quotes.

[cbrnr]

Thanks for pointing that out, I've fixed the .bib file.

I suggest the following reviewers: peterakirk, richrobe, tompollard, and DominiqueMakowski.

[emdupre]

@editorialbot check references

[editorialbot]

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

[emdupre]

@editorialbot commands

[editorialbot]

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

# List all available commands
@editorialbot commands

# Add to this issue's reviewers list
@editorialbot add @username as reviewer

# Remove from this issue's reviewers list
@editorialbot remove @username from reviewers

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

# Assign a user as the editor of this submission
@editorialbot assign @username as editor

# Remove the editor assigned to this submission
@editorialbot remove editor

# Remind an author, a reviewer or the editor to return to a review after a 
# certain period of time (supported units days and weeks)
@editorialbot remind @reviewer in 2 weeks

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

# Perform checks on the repository
@editorialbot check repository

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

# Set a value for version
@editorialbot set v1.0.0 as version

# Set a value for archive
@editorialbot set 10.21105/zenodo.12345 as archive

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

# Set a value for repository
@editorialbot set https://github.com/organization/repo as repository

# Mention the EiCs for the correct track
@editorialbot ping track-eic

# Generates the pdf paper
@editorialbot generate pdf

# Recommends the submission for acceptance
@editorialbot recommend-accept

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Flag submission with questionable scope
@editorialbot query scope

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

# Creates a post-review checklist with editor and authors tasks
@editorialbot create post-review checklist

# Open the review issue
@editorialbot start review

[emdupre]

@editorialbot check references

[editorialbot]

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

OK DOIs

- 10.1111/j.1469-8986.1966.tb02650.x is OK
- 10.1109/TBME.1985.325532 is OK
- 10.1161/01.CIR.93.5.1043 is OK
- 10.5664/jcsm.26814 is OK
- 10.3389/fpubh.2017.00258 is OK

MISSING DOIs

- None

INVALID DOIs

- None

[emdupre]

I suggest the following reviewers: peterakirk, richrobe, tompollard, and DominiqueMakowski.

Thank you ! I'll look through these suggestions and send out invitations soon.

[emdupre]

👋 Hi @peterakirk, @JanCBrammer, @DominiqueMakowski,

Would you be willing to review SleepECG: a Python package for sleep staging based on heart rate for JOSS (the Journal of Open Source Software)?

You can learn more about reviewing for JOSS -- including our conflict of interest policy -- here.

The review takes place on GitHub and focuses on the software and this short paper: https://github.com/openjournals/joss-papers/blob/joss.05378/joss.05378/10.21105.joss.05378.pdf

If you're available to review this work, please let me know and I'll add you as a reviewer. Once I have sufficient reviewers I'll open a dedicated review issue.

Thank you for considering !

[emdupre]

👋 Hi @richrobe, @tompollard, @sangfrois,

Would you be willing to review SleepECG: a Python package for sleep staging based on heart rate for JOSS (the Journal of Open Source Software)?

You can learn more about reviewing for JOSS -- including our conflict of interest policy -- here.

The review takes place on GitHub and focuses on the software and this short paper: https://github.com/openjournals/joss-papers/blob/joss.05378/joss.05378/10.21105.joss.05378.pdf

If you're available to review this work, please let me know and I'll add you as a reviewer. Once I have sufficient reviewers I'll open a dedicated review issue.

Thank you for considering !

[DominiqueMakowski]

Hiya! I'd be happy to review that ☺️ though I don't have much bandwidth at the moment so I can't guarantee a swift review

[tompollard]

Very cool, first time that I've received an invitation like this through GitHub!

I am a little overcommitted, but since this is something new and interesting I'd be happy to provide a review (from a quick look over the repo, it looks like a very clean, well-managed codebase).

I would also recommend Benjamin @bemoody as a reviewer. He is overcommitted like everyone else, but interest value might override this?

[emdupre]

Hi @DominiqueMakowski and @tompollard, thank you for letting me know !

I can go ahead and add you as a reviewer now, @tompollard ! When we have a sufficient number of reviewers, I'll open a separate review issue.

@DominiqueMakowski, we ask that reviews are returned at the latest within six weeks, though of course if you are able to complete it sooner, it would be appreciated. If that timeline would work for you, please let me know and I can also add you as a reviewer on the submission !

[emdupre]

@editorialbot add @tompollard as reviewer

[editorialbot]

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

[emdupre]

@editorialbot add @tompollard as reviewer

[editorialbot]

@tompollard added to the reviewers list!

[sangfrois]

Hi @emdupre ! So cool to hear from you through this platform! I greatly appreciate the invite. Though, I am also on a short bandwidth lately.

I'M FINALLY SENDING MY MASTERS THESIS EVERYBODY 💯 🥇 lol ... after practically four years. Never too late!

Anyways, I will be wrapping up a preprint in the coming weeks so I don't think I can be of much help for reviewing in time.

Please do hit me up if ever there are opportunities to review papers akin to this one (the work looks pretty neat). I will be up for the task at another time, promise!

hope to see you at OHBM, including you too @DominiqueMakowski

[richrobe]

Hi @emdupre! Yes, a little bit overcommitted as well, but anyways, I'd be happy to review this package :) Looks cool!

[peterakirk]

Hi @emdupre, I don't have expertise in sleep stage assessment, but I'd be happy to have a look through to check the documentation, installation, and a quick benchmarking to make sure HR/HRV metrics seem appropriate.

[JanCBrammer]

@emdupre, thanks for the invite. The package looks super interesting and well implemented / maintained! Would love to explore it, but cannot commit to a review due to time constraints atm.

[emdupre]

Thank you for your responses, @sangfrois, @richrobe , @peterakirk , and @JanCBrammer !

I'll go ahead and add you as reviewers on the submission now, @richrobe and @peterakirk. We should then have a sufficient number of reviewers to proceed, so I'll go ahead and open the review issue 🚀

Thank you for considering, @DominiqueMakowski @sangfrois @JanCBrammer !

[emdupre]

@editorialbot add @richrobe as reviewer

[editorialbot]

@richrobe added to the reviewers list!

[emdupre]

@editorialbot add @peterakirk as reviewer

[editorialbot]

@peterakirk added to the reviewers list!

[emdupre]

@editorialbot start review

[editorialbot]

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/5411.