[Docs] Add info about NK ECG peak detection method #1020
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Brief update to description of the 'neurokit' ecg_peaks method, to include the publication validating this algorithm.
JanCBrammer
approved these changes
Aug 6, 2024
|
@peterhcharlton, thanks for the PR! @DominiqueMakowski, as far as I'm concerned this one's good to merge. |
DominiqueMakowski
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR provides a brief update to description of the 'neurokit' ecg_peaks method, to include the publication validating this algorithm.
Proposed Changes
I changed the comments in the
ecg_peaks.pyfunction to add details of this publication which benchmarks the 'neurokit' ECG peak detection method.Checklist
Here are some things to check before creating the PR. If you encounter any issues, do let us know :)