Skip to content
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.

Sign up for GitHub

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

Jump to bottom

SleepStaging returns a yasa.Hypnogram instance #127

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

SleepStaging returns a yasa.Hypnogram instance #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4536b0c
First commit to update SleepStaging
raphaelvallat Dec 30, 2022
51d3fcd
Black formatting
raphaelvallat Dec 30, 2022
c09df80
Match stage names SleepStaging -> Hypnogram
raphaelvallat Dec 31, 2022
08abc31
Update CI
raphaelvallat Dec 31, 2022
0ffd7e0
Merge branch 'master' into sleepstaging_hypnogram
raphaelvallat Dec 31, 2022
65e3619
Add `proba` to yasa.Hypnogram + __repr__ to SleepStaging
raphaelvallat Dec 31, 2022
914e4f6
Black formatting
raphaelvallat Dec 31, 2022
c8ea05b
__str__ returns __repr__
raphaelvallat Jan 8, 2023
3d5c72e
Remove annoying warning
raphaelvallat Jan 8, 2023
3f92f8b
Merge branch 'master' into sleepstaging_hypnogram
raphaelvallat Jan 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,4 @@ notebooks/20_catch_errors.ipynb

# Custom
notebooks/debug*
notebooks/my_hypno.csv
15 changes: 10 additions & 5 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,23 @@ which comes with several pre-built functions (aka methods) and attributes. See f
hyp.duration # Total duration of the hypnogram, in minutes
hyp.sampling_frequency # Sampling frequency of the hypnogram
hyp.mapping # Mapping from strings to integers
hyp.proba # Probability of each sleep stage, if specified
# Below are some class methods
hyp.sleep_statistics() # Calculate the sleep statistics
hyp.plot_hypnogram() # Plot the hypnogram
hyp.upsample_to_data() # Upsample to data

Please see the documentation of :py:class:`yasa.Hypnogram` for more details.
This brings along critical changes to several YASA function, for example:

.. important::
The adoption of object-oriented :py:class:`yasa.Hypnogram` usage brings along critical changes to several YASA function, for example:
* :py:class:`yasa.SleepStaging` now returns a :py:class:`yasa.Hypnogram` instead of a :py:class:`numpy.ndarray`. The probability of each sleep stage for each epoch can now be accessed with :py:attr:`yasa.Hypnogram.proba`.
* :py:func:`yasa.simulate_hypnogram` now returns a :py:class:`yasa.Hypnogram` instead of a :py:class:`numpy.ndarray`.
* The suggested approach to plotting hypnograms is through the :py:meth:`yasa.Hypnogram.plot_hypnogram` method. The old function :py:func:`yasa.plot_hypnogram` still exists, but now *requires* a :py:class:`yasa.Hypnogram` instance as input.

**Other improvements**

* :py:func:`yasa.simulate_hypnogram` now returns a :py:class:`yasa.Hypnogram` instead of a :py:class:`numpy.ndarray`.
* The suggested approach to plotting hypnograms is through the :py:meth:`yasa.Hypnogram.plot_hypnogram` method. The old function :py:func:`yasa.plot_hypnogram` still exists, but now *requires* a :py:class:`yasa.Hypnogram` instance as input.
* Added helpful string representation (__repr__) to :py:class:`yasa.SleepStaging`.
* :py:func:`yasa.simulate_hypnogram` now returns a :py:class:`yasa.Hypnogram` instead of a :py:class:`numpy.ndarray`.
* The suggested approach to plotting hypnograms is through the :py:meth:`yasa.Hypnogram.plot_hypnogram` method. The old function :py:func:`yasa.plot_hypnogram` still exists, but now *requires* a :py:class:`yasa.Hypnogram` instance as input.

----------------------------------------------------------------------------------------

Expand Down