Skip to content

Commit dfd60e9

Browse files
committed
Update main documentation to prominently feature R analysis and deprecate Python analysis
1 parent 914f383 commit dfd60e9

File tree

2 files changed

+85
-2
lines changed

2 files changed

+85
-2
lines changed

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,36 @@ These tasks can run using minimal experimental settings: a computer and a record
2525

2626
The documentation can be found under the following [link](https://embodied-computation-group.github.io/Cardioception/#).
2727

28+
## 📊 Data Analysis
29+
30+
### 🎯 Recommended: R Analysis
31+
32+
**For comprehensive data analysis, we recommend using our R analysis scripts located in the `R_analysis/` directory.**
33+
34+
The R analysis provides:
35+
- **Individual subject analysis** with reaction time plots and signal detection theory metrics
36+
- **Group-level hierarchical analysis**
37+
- **Bayesian analysis** using Stan models
38+
- **Comprehensive visualization** of results
39+
40+
**🚀 Quick Start:**
41+
- **Individual subject analysis**: See `R_analysis/Example scripts/Example_analysis_simple.Rmd`
42+
- **Group-level analysis**: See `R_analysis/Example scripts/Example_analysis_Hierarchical.Rmd`
43+
- **Bayesian analysis**: See `R_analysis/Example scripts/Example_analysis_bayesian.Rmd`
44+
45+
For complete documentation and examples, see the [R Analysis README](R_analysis/README.md).
46+
47+
### 📈 Python Analysis (Outdated)
48+
49+
*Python analysis examples are available but are outdated and may not be maintained. For hierarchical Bayesian modeling, we strongly recommend using the R analysis approach above.*
50+
51+
Python users can find examples in the documentation, but these are primarily for reference. The Python analysis includes:
52+
- Basic preprocessing and reporting functions
53+
- Template notebooks for data visualization
54+
- Outdated Bayesian modeling examples
55+
56+
**⚠️ Important**: Users interested in hierarchical Bayesian modeling should refer to the R analysis code, which provides more comprehensive and up-to-date implementations.
57+
2858
## How to cite?
2959

3060
If you are using cardioception in a publication we ask you to cite the following paper:
@@ -155,7 +185,28 @@ This task implements an adaptive psychophysical procedure for estimating partici
155185

156186
# Analyses
157187

158-
## Task reports
188+
## 📊 Recommended: R Analysis
189+
190+
**For comprehensive data analysis, we recommend using our R analysis scripts located in the `R_analysis/` directory.**
191+
192+
The R analysis provides:
193+
- **Individual subject analysis** with reaction time plots and signal detection theory metrics
194+
- **Group-level hierarchical analysis**
195+
- **Bayesian analysis** using Stan models
196+
- **Comprehensive visualization** of results
197+
198+
**🚀 Quick Start:**
199+
- **Individual subject analysis**: See `R_analysis/Example scripts/Example_analysis_simple.Rmd`
200+
- **Group-level analysis**: See `R_analysis/Example scripts/Example_analysis_Hierarchical.Rmd`
201+
- **Bayesian analysis**: See `R_analysis/Example scripts/Example_analysis_bayesian.Rmd`
202+
203+
For complete documentation and examples, see the [R Analysis README](R_analysis/README.md).
204+
205+
## 📈 Python Analysis (Outdated)
206+
207+
*Python analysis examples are available but are outdated and may not be maintained. For hierarchical Bayesian modeling, we strongly recommend using the R analysis approach above.*
208+
209+
### Task reports
159210

160211
The results are saved in the `'resultPath'` folder defined in the parameters dictionary. For each task, we provide a comprehensive notebook detailing the main results, quality checks, and basic preprocessing steps. You can automatically generate the HTML reports using the following code snippet:
161212

@@ -177,10 +228,12 @@ You can also analyze the results in [Google Colab](https://colab.research.google
177228
| Heartbeat Counting task report | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/embodied-computation-group/Cardioception/blob/master/cardioception/notebooks/HeartBeatCounting.ipynb) | [![View the notebook](https://img.shields.io/badge/render-nbviewer-orange.svg)](https://nbviewer.jupyter.org/github/embodied-computation-group/Cardioception/blob/master/cardioception/notebooks/HeartBeatCounting.ipynb)
178229
| Heart Rate Discrimination task report | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/embodied-computation-group/Cardioception/blob/master/cardioception/notebooks/HeartRateDiscrimination.ipynb) | [![View the notebook](https://img.shields.io/badge/render-nbviewer-orange.svg)](https://nbviewer.jupyter.org/github/embodied-computation-group/Cardioception/blob/master/cardioception/notebooks/HeartRateDiscrimination.ipynb)
179230

180-
## Bayesian modeling
231+
### Bayesian modeling (Deprecated)
181232

182233
More advanced subject and group-level Bayesian modeling approaches are described in the following notebooks.
183234

235+
**⚠️ Important**: Users interested in hierarchical Bayesian modeling should refer to the R analysis code, which provides more comprehensive and up-to-date implementations.
236+
184237
| Notebook | Colab | nbViewer |
185238
| --- | ---| --- |
186239
| Fitting the psychometric function (single subject) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/embodied-computation-group/Cardioception/blob/master/docs/source/examples/psychophysics/1-psychophysics_subject_level.ipynb) | [![View the notebook](https://img.shields.io/badge/render-nbviewer-orange.svg)](https://nbviewer.jupyter.org/github/embodied-computation-group/embodied-computation-group/Cardioception/blob/master/docs/source/examples/psychophysics/1-psychophysics_subject_level.ipynb)

docs/source/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,36 @@ The Cardioception Python Package - Measuring Interoception with Psychopy - imple
2323

2424
These tasks can run using minimal experimental settings: a computer and a recording device to monitor the heart rate of the participant. The default version of the task uses the [Nonin 3012LP Xpod USB pulse oximeter](https://www.nonin.com/products/xpod/) together with [Nonin 8000SM 'soft-clip' fingertip sensors](https://www.nonin.com/products/8000s/). This sensor can be plugged directly into the stim PC via USB and will work with Cardioception without any additional coding required. The tasks can also integrate easily with other recording devices and experimental settings (ECG, M/EEG, fMRI...).
2525

26+
## 📊 Data Analysis
27+
28+
### 🎯 Recommended: R Analysis
29+
30+
**For comprehensive data analysis, we recommend using our R analysis scripts located in the `R_analysis/` directory.**
31+
32+
The R analysis provides:
33+
- **Individual subject analysis** with reaction time plots and signal detection theory metrics
34+
- **Group-level hierarchical analysis**
35+
- **Bayesian analysis** using Stan models
36+
- **Comprehensive visualization** of results
37+
38+
**🚀 Quick Start:**
39+
- **Individual subject analysis**: See `R_analysis/Example scripts/Example_analysis_simple.Rmd`
40+
- **Group-level analysis**: See `R_analysis/Example scripts/Example_analysis_Hierarchical.Rmd`
41+
- **Bayesian analysis**: See `R_analysis/Example scripts/Example_analysis_bayesian.Rmd`
42+
43+
For complete documentation and examples, see the [R Analysis README](../R_analysis/README.md).
44+
45+
### 📈 Python Analysis (Outdated)
46+
47+
*Python analysis examples are available but are outdated and may not be maintained. For hierarchical Bayesian modeling, we strongly recommend using the R analysis approach above.*
48+
49+
Python users can find examples in the documentation, but these are primarily for reference. The Python analysis includes:
50+
- Basic preprocessing and reporting functions
51+
- Template notebooks for data visualization
52+
- Outdated Bayesian modeling examples
53+
54+
**⚠️ Important**: Users interested in hierarchical Bayesian modeling should refer to the R analysis code, which provides more comprehensive and up-to-date implementations.
55+
2656
## Looking for help?
2757

2858
If you have questions regarding the tasks or want discuss data analysis, please contact Micah Allen directly.

0 commit comments

Comments
 (0)