Skip to content

Files

Latest commit

 

History

History
66 lines (53 loc) · 3.12 KB

README.rst

File metadata and controls

66 lines (53 loc) · 3.12 KB

peakdet: A toolbox for physiological peak detection analyses

This package is designed for use in the reproducible processing and analysis of physiological data, like those collected from respiratory belts, pulse photoplethysmography, or electrocardiogram (ECG/EKG) monitors.

https://travis-ci.org/rmarkello/peakdet.svg?branch=master https://readthedocs.org/projects/peakdet/badge/?version=latest

Overview

Physiological data are messy and prone to artifact (e.g., movement in respiration and pulse, ectopic beats in ECG). Despite leaps and bounds in recent algorithms for processing these data there still exists a need for manual inspection to ensure such artifacts have been appropriately removed. Because of this manual intervention step, understanding exactly what happened to go from "raw" data to "analysis-ready" data can often be difficult or impossible.

This toolbox, peakdet, aims to provide a set of tools that will work with a variety of input data to reproducibly generate manually-corrected, analysis- ready physiological data. If you'd like more information about the package, including how to install it and some example instructions on its use, check out our documentation!

Development and getting involved

This package has been largely developed in the spare time of a single graduate student (@rmarkello) with help from some incredible contributors. While it would be amazing if anyone else finds it helpful, given the limited time constraints of graduate school, the current package is not currently accepting requests for new features.

However, if you're interested in getting involved in the project, we're thrilled to welcome new contributors! You should start by reading our contributing guidelines and code of conduct. Once you're done with that, take a look at our issues to see if there's anything you might like to work on. Alternatively, if you've found a bug, are experiencing a problem, or have a question, create a new issue with some information about it!

License Information

This codebase is licensed under the Apache License, Version 2.0. The full license can be found in the LICENSE file in the peakdet distribution. You may also obtain a copy of the license at: http://www.apache.org/licenses/LICENSE-2.0.