Skip to content

Commit

Permalink
Add a note about the units used for the time-based HRV metrics.
Browse files Browse the repository at this point in the history
  • Loading branch information
aweinstein authored Nov 15, 2024
1 parent 45c9ad9 commit b33a7b8
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions neurokit2/hrv/hrv_time.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@ def hrv_time(peaks, sampling_rate=1000, show=False, **kwargs):
--------
ecg_peaks, ppg_peaks, hrv_frequency, hrv_summary, hrv_nonlinear
Notes
-----
Where applicable, the unit used for these metrics is the millisecond.
Examples
--------
.. ipython:: python
Expand Down

0 comments on commit b33a7b8

Please sign in to comment.