Metadata-Version: 2.1
Name: rapidhrv
Version: 0.1.2
Summary: A package for preprocessing, analyzing, and visualizing cardiac data
Home-page: https://github.com/peterakirk/RapidHRV/
Author: Peter Kirk
Author-email: p.kirk@ucl.ac.uk
License: MIT License
Description: ![Logo](https://github.com/peterakirk/RapidHRV/blob/main/Images/Logo.png?raw=true)
        
        
        RapidHRV is a Python pipeline for the analysis and visualization of cardiac data (validated on ECG, Pulse Oximetry, and PPG).
        
        ## Installation
        
        ```bash
        pip install rapidhrv
        ```
        
        ## Usage
        RapidHRV comes with three modules, each of which requires one function to run. For a step-by-step tutorial, see 
        [Tutorial.md](https://github.com/peterakirk/RapidHRV/blob/main/Tutorial/Tutorial.md).
        
        ```python
        from rapidhrv import preprocess, analyze, visualize
        
        procData = preprocess.preprocess(inputdata=mydata, samplingrate=250)  # returns upsampled, high-pass filtered, smoothed data
        
        analyzedData = analyze.extract_heart(inputdata=procData,resampledrate=1000)  # returns dictionary with analyzed data
        
        fig = visualize.Visualize(inputdata=procData, inputframe=analyzedData)  # returns interactive matplotlib object, displaying BPM and RMSSD time series
        ```
        
        Based on our validation paper (https://psyarxiv.com/3ewgz/), we make the following modality-specific suggestions as 
        starting points for function arguments.
        
        ![Suggestions](https://github.com/peterakirk/RapidHRV/blob/main/Images/Modality_suggestions.png?raw=true)
        
        ## Visualization Bug
        
        At present (>= V 0.0.1), the visualization module has been verified to work in Pycharm on an Ubuntu 20.04 OS. Some users 
        have noted issues with interactive plotting in other IDEs/operating systems. We are currently working on a fix.
        
        Spyder users: You'll need to change the backend to automatic via Tools > preferences > IPython console > Graphics > 
        Graphics backend > Backend: Automatic. Then restart Spyder. Instead of plotting figures in the console, this will open 
        figures in a new window.
        
        ## License
        MIT License
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
