search

mad-lab-fau / BioPsyKit

A Python package for the analysis of biopsychological data.
MIT License
42 stars 8 forks source link

What is the expected convention for sleep? #35

Closed rouzbeh closed 2 years ago

rouzbeh commented 2 years ago

This line seems to indicate that sleep is marked as 0. https://github.com/mad-lab-fau/BioPsyKit/blob/376e3a04f80e68daa6d36f8ecd1e1b527a8d7193/src/biopsykit/sleep/sleep_endpoints/sleep_endpoints.py#L44

But this line seems to contradict it: https://github.com/mad-lab-fau/BioPsyKit/blob/376e3a04f80e68daa6d36f8ecd1e1b527a8d7193/src/biopsykit/sleep/sleep_endpoints/sleep_endpoints.py#L61

richrobe commented 2 years ago

Hi @rouzbeh, thanks for pointing this out! The expected convention is 1 for sleep and 0 for wake. Hence, it's a typo in the documentation. I will update it accordingly!

richrobe commented 2 years ago

fixed in 4684da2