No description or website provided.
Switch branches/tags
Nothing to show
Clone or download
paulvangentcom V1.1
added reference to technical paper pre-print
Latest commit 037f7f3 Nov 6, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/source V1.1 Nov 6, 2018
heartpy V1.1 Nov 6, 2018
images V0.8.1 Jun 1, 2018
old V1.1 Nov 6, 2018
validation V1.0 Oct 5, 2018
.gitignore V0.8.3 Jul 18, 2018
LICENSE Create LICENSE Jul 19, 2018
README.md V1.1 Nov 6, 2018
changelog.log V1.1 Nov 6, 2018
data.csv updated for example May 23, 2017
data.mat example files May 22, 2017
data2.csv code optimalisation May 19, 2017
data2.mat example files May 22, 2017
data3.csv test dataset May 22, 2017
data3.mat example files May 22, 2017
doctests.txt V1.1 Nov 6, 2018
setup.py V1.1 Nov 6, 2018

README.md

A note to our friends from the Humanist 2018 conference

This is the package presented at the Humanist 2018 conference in the Hague, Netherlands. Note that it is always in active development. Whenever including it in your research, pull the latest version from this GitHub. Support is always available at: P.vanGent@tudelft.nl.

Thank you for your interest

Installation

python -m setup.py install

Alternatively, we're also on PIP:

python -m pip install heartpy

That's it!

Official Documentation

The official documentation is online! You can find the official documentation here

HeartPy - Python Heart Rate Analysis Toolkit

DOI

HeartPy, the Python Heart Rate Analysis Toolkit is a module for heart rate analysis in Python. It started as pure-python implementation to analyse physiological data taken in naturalistisch driving and cycling experiments.

The module takes a discrete heart rate signal and outputs time-domain and frequency-domain measures often found in scientific literature:

Time domain:

  • beats per minute, BPM
  • interbeat interval, IBI
  • standard deviation if intervals between adjacent beats, SDNN
  • standard deviation of successive differences between adjacent R-R intervals, SDSD
  • root mean square of successive differences between adjacend R-R intervals, RMSSD
  • proportion of differences between R-R intervals greater than 20ms, 50ms, pNN20, pNN50
  • median absolute deviation, MAD

Frequency domain

  • low frequency component (0.04-0.15Hz), LF
  • high frequency component (0.16-0.5Hz), HF
  • lf/hf ratio, Lf/HF

When using the package in your research, please cite:

van Gent, P., Farah, H., van Nes, N., & van Arem, B. (2018). Heart Rate Analysis for Human Factors: Development and Validation of an Open Source Toolkit for Noisy Naturalistic Heart Rate Data. In Proceedings of the 6th HUMANIST Conference (pp. 173–178).

van Gent, P. Van, Farah, H., Nes, N. Van, & Arem, B. Van. (manuscript submitted). A Novel Heart Rate Algorithm for the Analysis of Noisy Signals. Doi: doi.org/10.13140/RG.2.2.24895.56485

Documentation

You can find the official documentation here

The module is also to some extent described in my tutorial series:

License

The module is licensed under the GNU General Public License Version3, GPL-v3

Validation

Initial results of the validation have been reported in [1, 2]. Updates here are soon to follow once the papers are published.

[1]van Gent, P., Farah, H., van Nes, N., & van Arem, B. (2018). Heart Rate Analysis for Human Factors: Development and Validation of an Open Source Toolkit for Noisy Naturalistic Heart Rate Data. In Proceedings of the 6th HUMANIST Conference (pp. 173–178).

[2] van Gent, P. Van, Farah, H., Nes, N. Van, & Arem, B. Van. (manuscript submitted for publication). A Novel Heart Rate Algorithm for the Analysis of Noisy Signals.

To-do

The module is still in active development. See the changelog for past changes. The to-do for the coming months is:

to do before V1.1.1

  • Validate performance on Physionet datasets
  • Report validation performance on repo (published paper + key-points document)
  • Add R-position interpolation ('high accuracy' mode)
  • Handle cases where strong T-peak in signal is present
  • Include example data on PIP release