updated README

PhysiologicAILab · Oct 21, 2023 · 995018a · 995018a
1 parent 1a70b53
commit 995018a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -100,7 +100,8 @@ A brief description of each step is mentioned below:
 ---
 
 ### **Data Analysis**
-Jupyter notebooks *phys_analysis_eda.ipynb*, *phys_analysis_ppg.ipynb*, and *phys_analysis_resp.ipynb* are provided to illustrate basic analysis steps. This includes pre-processing as well as feature extraction for EDA, PPG and Resp signals respectively. 
+Data analysis is supported by the *analysis_helper* folder. To extract features and export in spreadsheet, please refer to the README provided within the folder.
+In addition, Jupyter notebooks *phys_analysis_eda.ipynb*, *phys_analysis_ppg.ipynb*, and *phys_analysis_resp.ipynb* are provided to illustrate basic analysis steps. This includes pre-processing as well as feature extraction for EDA, PPG and Resp signals respectively.
 
 ---
 ### **Additional Support or Reporting Issues with the Library**: 

diff --git a/analysis_helper/README.md b/analysis_helper/README.md
@@ -1,12 +1,15 @@
 # Data Analysis Helper
 
-### Step-1: Batch processing to compute metrics from PPG and EDA signals:
+### Step-1: Preparing the data and the configuration file
+Sample data and corresponding exp_config.json file is provided to illustrate how to specify the data to be analysed in the configuration file. It is crucial to provide the sampling rate (fs) and total_duration as per that used for data acquisition. Rest of the parameters are self-explanatory, though we will be preparing detailed tutorials and sharing the links to tutorial videos here.
+
+### Step-2: Batch processing to compute metrics from PPG and EDA signals:
 
 ``` bash
 python -m analysis_helper.process_signals --config analysis_helper/exp_config.json --datapath analysis_helper sample_data --opt 0
 ```
 
-### Step-2: Saving and exporting data-tables
+### Step-3: Saving and exporting data-tables
 
 Following command is to illustrate the use when a specific window size and step size is used, i.e. "W65_S10_nk_OptPPG".
 

diff --git a/analysis_helper/exp_config.json b/analysis_helper/exp_config.json
@@ -1,8 +1,8 @@
 {
     "save_plot_flag": true,
     "fs": 250,
-    "fs_margin": 30,
     "total_duration": 300,
+    "fs_margin": 30,
     "winlen": 30,
     "step_len": 5,
     "low_cut_freq": 0.5,