Skip to content

Commit

Permalink
Merge pull request #1004 from atpage/atpage-typo
Browse files Browse the repository at this point in the history
[Docs] typo in ecg_quality docstring
  • Loading branch information
DominiqueMakowski authored Jul 4, 2024
2 parents 7df75ad + 4c1aaeb commit a56c909
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion neurokit2/ecg/ecg_quality.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def ecg_quality(
interpolating the distance of each QRS segment from the average QRS segment present in the *
data. This index is therefore relative: 1 corresponds to heartbeats that are the closest to
the average sample and 0 corresponds to the most distant heartbeat from that average sample.
Note that 1 does not necessarily means "good": if the majority of samples are bad, than being
Note that 1 does not necessarily means "good": if the majority of samples are bad, then being
close to the average will likely mean bad as well. Use this index with care and plot it
alongside your ECG signal to see if it makes sense.
Expand Down

0 comments on commit a56c909

Please sign in to comment.