Update README

StanfordBDHG · Mar 14, 2024 · 3744bfc · 3744bfc
1 parent de60a99
commit 3744bfc
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 112 deletions.
diff --git a/ECGDataPipelineTemplate/ECGDataPipelineTemplate.ipynb b/ECGDataPipelineTemplate/ECGDataPipelineTemplate.ipynb
@@ -37,8 +37,7 @@
     "from Modules.firebase_access import *\n",
     "from Modules.data_preparation import *\n",
     "from Modules.visualization import *\n",
-    "from Modules.utils import *\n",
-    "import os"
+    "from Modules.utils import *"
    ]
   },
   {

diff --git a/ECGDataPipelineTemplate/README.md b/ECGDataPipelineTemplate/README.md
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ SPDX-License-Identifier: MIT
 [![Beta Deployment](https://github.com/StanfordBDHG/PediatricAppleWatchStudy/actions/workflows/beta-deployment.yml/badge.svg)](https://github.com/StanfordBDHG/PediatricAppleWatchStudy/actions/workflows/beta-deployment.yml)
 [![codecov](https://codecov.io/gh/StanfordBDHG/PediatricAppleWatchStudy/graph/badge.svg?token=0SNRhbC0wi)](https://codecov.io/gh/StanfordBDHG/PediatricAppleWatchStudy)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10602852.svg)](https://doi.org/10.5281/zenodo.10602852)
-[![Open Data Pipeline In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/[YourGitHub]/SpeziECGDataAnalysisPipeline/blob/main/SpeziECGDataInteractiveTool.ipynbhttps://colab.research.google.com/github/StanfordBDHG/PediatricAppleWatchStudy/blob/main/ECGDataPipelineTemplate/ECGDataPipelineTemplate.ipynb)
+
 
 This repository contains the Pediatric Apple Watch Study Application application.
 The Pediatric Apple Watch Study Application is using the [Spezi](https://github.com/StanfordSpezi/Spezi) ecosystem and builds on top of the [Stanford Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication).
@@ -44,7 +44,7 @@ The Spezi ECG Data Pipeline adopts a modular structure, comprising several Pytho
 - `data_preparation.py`: Prepares and processes raw ECG data.
 - `utils.py`: Provides utility functions for data processing.
 - `visualization.py`: Contains functions for data visualization.
-- `SpeziECGDataIteractECGDataPipelineTemplateiveTool.ipynb`: An interactive notebook for analyzing and reviewing ECG data.
+- `ECGDataPipelineTemplate.ipynb`: An interactive notebook for analyzing and reviewing ECG data.
 
 ### Run the Notebook in Google Colab
 
@@ -55,7 +55,7 @@ You can open and run the `ECGDataPipelineTemplate.ipynb` notebook in Google Cola
 Once the notebook is open in Colab, execute the following cell to clone the Spezi ECG Data Analysis Pipeline repository and navigate into the cloned directory:
 
 ```python
-# Cell 1: Clone GitHub repository for Spezi ECG Data Pipeline
+# Clone GitHub repository for Spezi ECG Data Pipeline
 !git clone https://github.com/StanfordBDHG/PediatricAppleWatchStudy.git
 %cd PediatricAppleWatchStudy/ECGDataPipeline
 ```
@@ -64,26 +64,7 @@ Remember to upload the `serviceAccountKey_file.json` to the Colab workspace dire
 
 ### Use the Interactive ECG Reviewing Tool
 
-To start reviewing ECG data, execute the following cells in your notebook:
-
-```python
-# Cell 2: Import modules
-from Modules.firebase_access import *
-from Modules.data_preparation import *
-from Modules.visualization import *
-from Modules.utils import *
-import os
-
-# Cell 3: Define the path to your service account key file 
-serviceAccountKey_file = 'path/to/serviceAccountKey.json'
-
-# Cell 4: Connect to Firebase and download data
-db = connect_to_firebase(serviceAccountKey_file)
-ecg_data = process_data(db)
-
-# Cell 5: Initialize the ECG Data Viewer and start reviewing
-viewer = ECGDataViewer(ecg_data, db)
-```
+To start reviewing ECG data, execute the cells in your notebook. 
 
 This interactive tool allows you to plot ECG data, add diagnoses, evaluate the trace quality, and add notes.