Add ECG Data Pipeline Tool

[Vicbi]

Add ECG Data Pipeline Tool

♻️ Current situation & Problem

This PR adds the ECG Data Pipeline tool into a separate folder in the root of the project repository. Currently, the project lacks a dedicated pipeline for processing, analyzing and visualising the ECG data. This addition aims to provide a streamlined way to handle ECG data with enhanced analysis and visualisation capabilities.

⚙️ Release Notes

• Added ECG Data Pipeline folder containing the pipeline tool for processing, analyzing, and visualising ECG data.
• The pipeline includes modules for data preparation, access to Firebase, utility functions, and data visualization, alongside an interactive Python notebook (ECGDataPipelineTemplate.ipynb) for ECG data review.
• Migration Guide: No breaking changes introduced. Users can integrate the pipeline tool into their workflow by cloning the repository and following the setup instructions in the README.

!git clone https://github.com/StanfordBDHG/PediatricAppleWatchStudy.git
%cd PediatricAppleWatchStudy/ECGDataPipeline

📚 Documentation

The ECG Data Pipeline tool is fully documented. The README within the ECG Data Pipeline folder provides an overview, setup instructions, and usage examples for integration and utilization of the tool.

✅ Testing

A job to build and test the ECG Data Pipeline notebook was added into the existing workflow build-and-test. This includes setting up Python, NodeJS, Java, and LaTeX environments; installing necessary dependencies; and executing the notebook with Firebase emulators to validate the data pipeline's functionality. The notebook is then converted to a PDF document, which is uploaded as an artifact for review.

Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

• I agree to follow the Code of Conduct and Contributing Guidelines.

[PSchmiedmayer]

@Vicbi I have not taken a closer look at the Python code as I trust you with that and we will have to remodel this for the shared python package anyways.

I had a few suggestions about the documentation and general structure that we could incorporate.

Let's keep this PR open for a bit until we synced back with Scott and Aydin after the next meeting and the next iteration of the tool.

[PSchmiedmayer]

@Vicbi The latest commit should fix the Xcode Build issue 👍

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.17%. Comparing base (2e271bb) to head (9d17378).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #53   +/-   ##
=======================================
  Coverage   28.17%   28.17%           
=======================================
  Files          34       34           
  Lines        1232     1232           
=======================================
  Hits          347      347           
  Misses        885      885           

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2e271bb...9d17378. Read the comment docs.

[Vicbi]

Thanks for taking care of the Xcode Build issue @PSchmiedmayer ! All other changes were made 👍

[PSchmiedmayer]

Thank you for the improvements; I had a few comments and elements that I observed in the README and other parts of the code that would be great to address before we merge the PR.