Skip to content

Commit 3f92f8b

Browse files
raphaelvallatraphaelvallat
authored
Merge branch 'master' into sleepstaging_hypnogram
2 parents 3d5c72e + 6b37c63 commit 3f92f8b

File tree

112 files changed

+7281
-3345
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+7281
-3345
lines changed

‎.github/workflows/python_tests.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ jobs:
1111
strategy:
1212
fail-fast: false
1313
matrix:
14-
platform: [ubuntu-latest, windows-latest] # macos-latest,
15-
python-version: [3.7, 3.8, 3.9]
14+
platform: [ubuntu-latest, macos-latest, windows-latest]
15+
python-version: ["3.8", "3.9", "3.10", "3.11"]
1616

1717
runs-on: ${{ matrix.platform }}
1818

@@ -39,7 +39,7 @@ jobs:
3939
pytest --cov --cov-report=xml --cov-config=setup.cfg --verbose
4040
4141
- name: Upload coverage report
42-
if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == 3.8 }}
42+
if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == 3.9 }}
4343
uses: codecov/codecov-action@v1
4444
with:
4545
token: a58a0c62-fb11-4429-977b-65bec01ecb44

‎README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Below some plots demonstrating the functionalities of YASA. To reproduce these,
119119
Development
120120
~~~~~~~~~~~
121121

122-
YASA was created and is maintained by `Raphael Vallat <https://raphaelvallat.com>`_, a postdoctoral researcher in `Matthew Walker's lab <https://www.humansleepscience.com/>`_ at UC Berkeley. Contributions are more than welcome so feel free to contact me, open an issue or submit a pull request!
122+
YASA was created and is maintained by `Raphael Vallat <https://raphaelvallat.com>`_, a former postdoctoral researcher in `Matthew Walker's lab <https://www.humansleepscience.com/>`_ at UC Berkeley. Contributions are more than welcome so feel free to contact me, open an issue or submit a pull request!
123123

124124
To see the code or report a bug, please visit the `GitHub repository <https://github.com/raphaelvallat/yasa>`_.
125125

‎docs/api.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ Hypnogram & sleep statistics
3131
.. autosummary::
3232
:toctree: generated/
3333

34-
Hypnogram
3534
hypno_upsample_to_data
3635
hypno_upsample_to_sf
3736
hypno_str_to_int
@@ -42,7 +41,8 @@ Hypnogram & sleep statistics
4241
plot_spectrogram
4342
transition_matrix
4443
sleep_statistics
45-
simulate_hypno
44+
Hypnogram
45+
simulate_hypnogram
4646

4747
Spectral analyses
4848
-----------------

‎docs/build/html/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 53802cc2376a375a855b3c0f38207c28
3+
config: 489cdac284cc185cfdae105616c5af8a
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_images/yasa-Hypnogram-1.png

12.7 KB
Loading

‎docs/build/html/_images/yasa-plot_hypnogram-1.png

6.49 KB
Loading

‎docs/build/html/_images/yasa-plot_hypnogram-2.png

16.4 KB
Loading

‎docs/build/html/_images/yasa-plot_hypnogram-3.png

14.7 KB
Loading

‎docs/build/html/_images/yasa-plot_spectrogram-1.png

0 Bytes
Loading

‎docs/build/html/_images/yasa-plot_spectrogram-2.png

1.49 KB
Loading

‎docs/build/html/_images/yasa-simulate_hypno-1.png

-19.5 KB
Binary file not shown.

‎docs/build/html/_images/yasa-simulate_hypnogram-1.png

19.5 KB
Loading

‎docs/build/html/_images/yasa-topoplot-1.png

-90 Bytes
Loading

‎docs/build/html/_images/yasa-topoplot-2.png

72 Bytes
Loading

‎docs/build/html/_images/yasa-transition_matrix-1.png

0 Bytes
Loading

‎docs/build/html/_modules/index.html

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
<!DOCTYPE html>
22

3-
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<html>
44
<head>
55
<meta charset="utf-8" />
6-
<title>Overview: module code &#8212; yasa 0.6.3 documentation</title>
7-
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
8-
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Overview: module code &#8212; yasa 0.6.4 documentation</title>
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
9+
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css" />
910
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
1011
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
1112
<link rel="stylesheet" type="text/css" href="../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
1213
<link rel="stylesheet" type="text/css" href="../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
1314
<link rel="stylesheet" type="text/css" href="../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
14-
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
15+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
1516
<script src="../_static/jquery.js"></script>
1617
<script src="../_static/underscore.js"></script>
1718
<script src="../_static/doctools.js"></script>
18-
<script src="../_static/language_data.js"></script>
1919
<script src="../_static/clipboard.min.js"></script>
2020
<script src="../_static/copybutton.js"></script>
21-
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
2221
<link rel="shortcut icon" href="../_static/favicon.ico"/>
2322
<link rel="index" title="Index" href="../genindex.html" />
2423
<link rel="search" title="Search" href="../search.html" />
2524
<meta charset='utf-8'>
2625
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
2726
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
2827
<meta name="apple-mobile-web-app-capable" content="yes">
29-
<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js "></script>
30-
<script type="text/javascript" src="../_static/js/jquery-fix.js "></script>
31-
<script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js "></script>
32-
<script type="text/javascript" src="../_static/bootstrap-sphinx.js "></script>
28+
<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
29+
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
30+
<script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
31+
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
3332

3433
</head><body>
3534

@@ -44,7 +43,7 @@
4443
</button>
4544
<a class="navbar-brand" href="../index.html"><span><img src="../_static/yasa_128x128.png"></span>
4645
yasa</a>
47-
<span class="navbar-text navbar-version pull-left"><b>0.6.3</b></span>
46+
<span class="navbar-text navbar-version pull-left"><b>0.6.4</b></span>
4847
</div>
4948

5049
<div class="collapse navbar-collapse nav-collapse">
@@ -118,8 +117,8 @@ <h1>All modules for which code is available</h1>
118117

119118
</p>
120119
<p>
121-
&copy; Copyright 2018-2022, Dr. Raphael Vallat, Center for Human Sleep Science, UC Berkeley.<br/>
122-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.0.<br/>
120+
&copy; Copyright 2018-2024, Dr. Raphael Vallat, Center for Human Sleep Science, UC Berkeley.<br/>
121+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.4.0.<br/>
123122
</p>
124123
</div>
125124
</footer>

‎docs/build/html/_modules/yasa/detection.html

+18-16
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
<!DOCTYPE html>
22

3-
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<html>
44
<head>
55
<meta charset="utf-8" />
6-
<title>yasa.detection &#8212; yasa 0.6.3 documentation</title>
7-
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
8-
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>yasa.detection &#8212; yasa 0.6.4 documentation</title>
8+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
9+
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
910
<link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
1011
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
1112
<link rel="stylesheet" type="text/css" href="../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
1213
<link rel="stylesheet" type="text/css" href="../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
1314
<link rel="stylesheet" type="text/css" href="../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
14-
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
15+
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
1516
<script src="../../_static/jquery.js"></script>
1617
<script src="../../_static/underscore.js"></script>
1718
<script src="../../_static/doctools.js"></script>
18-
<script src="../../_static/language_data.js"></script>
1919
<script src="../../_static/clipboard.min.js"></script>
2020
<script src="../../_static/copybutton.js"></script>
21-
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
2221
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
2322
<link rel="index" title="Index" href="../../genindex.html" />
2423
<link rel="search" title="Search" href="../../search.html" />
2524
<meta charset='utf-8'>
2625
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
2726
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
2827
<meta name="apple-mobile-web-app-capable" content="yes">
29-
<script type="text/javascript" src="../../_static/js/jquery-1.12.4.min.js "></script>
30-
<script type="text/javascript" src="../../_static/js/jquery-fix.js "></script>
31-
<script type="text/javascript" src="../../_static/bootstrap-3.4.1/js/bootstrap.min.js "></script>
32-
<script type="text/javascript" src="../../_static/bootstrap-sphinx.js "></script>
28+
<script type="text/javascript" src="../../_static/js/jquery-1.12.4.min.js"></script>
29+
<script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
30+
<script type="text/javascript" src="../../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
31+
<script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
3332

3433
</head><body>
3534

@@ -44,7 +43,7 @@
4443
</button>
4544
<a class="navbar-brand" href="../../index.html"><span><img src="../../_static/yasa_128x128.png"></span>
4645
yasa</a>
47-
<span class="navbar-text navbar-version pull-left"><b>0.6.3</b></span>
46+
<span class="navbar-text navbar-version pull-left"><b>0.6.4</b></span>
4847
</div>
4948

5049
<div class="collapse navbar-collapse nav-collapse">
@@ -919,7 +918,6 @@ <h1>Source code for yasa.detection</h1><div class="highlight"><pre>
919918
<span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">()</span>
920919

921920
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n_chan</span><span class="p">):</span>
922-
923921
<span class="c1"># ####################################################################</span>
924922
<span class="c1"># START SINGLE CHANNEL DETECTION</span>
925923
<span class="c1"># ####################################################################</span>
@@ -2426,6 +2424,7 @@ <h1>Source code for yasa.detection</h1><div class="highlight"><pre>
24262424
<span class="n">include</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
24272425
<span class="n">amplitude</span><span class="o">=</span><span class="p">(</span><span class="mi">50</span><span class="p">,</span> <span class="mi">325</span><span class="p">),</span>
24282426
<span class="n">duration</span><span class="o">=</span><span class="p">(</span><span class="mf">0.3</span><span class="p">,</span> <span class="mf">1.2</span><span class="p">),</span>
2427+
<span class="n">relative_prominence</span><span class="o">=</span><span class="mf">0.8</span><span class="p">,</span>
24292428
<span class="n">freq_rem</span><span class="o">=</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mi">5</span><span class="p">),</span>
24302429
<span class="n">remove_outliers</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
24312430
<span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
@@ -2483,6 +2482,9 @@ <h1>Source code for yasa.detection</h1><div class="highlight"><pre>
24832482
<span class="sd"> duration : tuple or list</span>
24842483
<span class="sd"> The minimum and maximum duration of the REMs.</span>
24852484
<span class="sd"> Default is 0.3 to 1.2 seconds.</span>
2485+
<span class="sd"> relative_prominence : float</span>
2486+
<span class="sd"> Relative prominence used to detect the peaks. The actual prominence is computed</span>
2487+
<span class="sd"> by multiplying relative prominence by the minimal amplitude. Default is 0.8.</span>
24862488
<span class="sd"> freq_rem : tuple or list</span>
24872489
<span class="sd"> Frequency range of REMs. Default is 0.5 to 5 Hz.</span>
24882490
<span class="sd"> remove_outliers : boolean</span>
@@ -2589,7 +2591,7 @@ <h1>Source code for yasa.detection</h1><div class="highlight"><pre>
25892591
<span class="n">negp</span><span class="p">,</span>
25902592
<span class="n">height</span><span class="o">=</span><span class="p">(</span><span class="n">hmin</span><span class="p">,</span> <span class="n">hmax</span><span class="p">),</span>
25912593
<span class="n">distance</span><span class="o">=</span><span class="p">(</span><span class="n">duration</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="n">sf</span><span class="p">),</span>
2592-
<span class="n">prominence</span><span class="o">=</span><span class="p">(</span><span class="mf">0.8</span> <span class="o">*</span> <span class="n">hmin</span><span class="p">),</span>
2594+
<span class="n">prominence</span><span class="o">=</span><span class="p">(</span><span class="n">relative_prominence</span> <span class="o">*</span> <span class="n">hmin</span><span class="p">),</span>
25932595
<span class="n">wlen</span><span class="o">=</span><span class="p">(</span><span class="n">duration</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">*</span> <span class="n">sf</span><span class="p">),</span>
25942596
<span class="p">)</span>
25952597

@@ -3458,8 +3460,8 @@ <h1>Source code for yasa.detection</h1><div class="highlight"><pre>
34583460

34593461
</p>
34603462
<p>
3461-
&copy; Copyright 2018-2022, Dr. Raphael Vallat, Center for Human Sleep Science, UC Berkeley.<br/>
3462-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.0.<br/>
3463+
&copy; Copyright 2018-2024, Dr. Raphael Vallat, Center for Human Sleep Science, UC Berkeley.<br/>
3464+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.4.0.<br/>
34633465
</p>
34643466
</div>
34653467
</footer>

‎docs/build/html/_modules/yasa/heart.html

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
<!DOCTYPE html>
22

3-
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<html>
44
<head>
55
<meta charset="utf-8" />
6-
<title>yasa.heart &#8212; yasa 0.6.3 documentation</title>
7-
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
8-
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>yasa.heart &#8212; yasa 0.6.4 documentation</title>
8+
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
9+
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
910
<link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
1011
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
1112
<link rel="stylesheet" type="text/css" href="../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
1213
<link rel="stylesheet" type="text/css" href="../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
1314
<link rel="stylesheet" type="text/css" href="../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
14-
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
15+
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
1516
<script src="../../_static/jquery.js"></script>
1617
<script src="../../_static/underscore.js"></script>
1718
<script src="../../_static/doctools.js"></script>
18-
<script src="../../_static/language_data.js"></script>
1919
<script src="../../_static/clipboard.min.js"></script>
2020
<script src="../../_static/copybutton.js"></script>
21-
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
2221
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
2322
<link rel="index" title="Index" href="../../genindex.html" />
2423
<link rel="search" title="Search" href="../../search.html" />
2524
<meta charset='utf-8'>
2625
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
2726
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
2827
<meta name="apple-mobile-web-app-capable" content="yes">
29-
<script type="text/javascript" src="../../_static/js/jquery-1.12.4.min.js "></script>
30-
<script type="text/javascript" src="../../_static/js/jquery-fix.js "></script>
31-
<script type="text/javascript" src="../../_static/bootstrap-3.4.1/js/bootstrap.min.js "></script>
32-
<script type="text/javascript" src="../../_static/bootstrap-sphinx.js "></script>
28+
<script type="text/javascript" src="../../_static/js/jquery-1.12.4.min.js"></script>
29+
<script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
30+
<script type="text/javascript" src="../../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
31+
<script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
3332

3433
</head><body>
3534

@@ -44,7 +43,7 @@
4443
</button>
4544
<a class="navbar-brand" href="../../index.html"><span><img src="../../_static/yasa_128x128.png"></span>
4645
yasa</a>
47-
<span class="navbar-text navbar-version pull-left"><b>0.6.3</b></span>
46+
<span class="navbar-text navbar-version pull-left"><b>0.6.4</b></span>
4847
</div>
4948

5049
<div class="collapse navbar-collapse nav-collapse">
@@ -304,8 +303,8 @@ <h1>Source code for yasa.heart</h1><div class="highlight"><pre>
304303

305304
</p>
306305
<p>
307-
&copy; Copyright 2018-2022, Dr. Raphael Vallat, Center for Human Sleep Science, UC Berkeley.<br/>
308-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.0.<br/>
306+
&copy; Copyright 2018-2024, Dr. Raphael Vallat, Center for Human Sleep Science, UC Berkeley.<br/>
307+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.4.0.<br/>
309308
</p>
310309
</div>
311310
</footer>

0 commit comments

Comments
 (0)