Skip to content

DOC: Improve examples in signal.find_peaks with ECG signal #8695

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.

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

Merged
merged 1 commit into from
Apr 8, 2018

Conversation

lagru
Copy link
Contributor

@lagru lagru commented Apr 8, 2018

This PR should improve the example section of scipy.signal.find_peaks documentation. If you feel that something could be explained better or is confusing please let me know.

My thoughts behind this are:

  • Use scipy.misc.electrocardiogram as the demo signal to move the examples a little closer to real world use cases.
  • Demonstrate different use cases: half open and dynamic intervals, combining conditions.
  • Nearly all conditions (expect threshold) are covered with at least one example and one plot. I didn't find a meaningful use for threshold that has an explanatory value.

@lagru
Copy link
Contributor Author

lagru commented Apr 8, 2018

[Rendered docstring]

By the way, is there an easy method to access the documentation created by CircleCI? The only way I know is to search for the correct link in the returned JSON here:
https://circleci.com/api/v1.1/project/github/scipy/scipy/BUILDNUMBER/artifacts

@larsoner
Copy link
Member

larsoner commented Apr 8, 2018

Follow the CircleCI build link from the GitHub status at the bottom of the PR, and make sure you're signed in (via GitHub auth) to CircleCI. An "Artifacts" tab should show up.

@lagru
Copy link
Contributor Author

lagru commented Apr 8, 2018

Ah, thank you! I wasn't sure if I was missing the rights to access the artifacts.

@pv pv merged commit 150e7f7 into scipy:master Apr 8, 2018
@pv pv added this to the 1.1.0 milestone Apr 8, 2018
@lagru lagru deleted the find-peaks branch April 8, 2018 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants