From e178b0e9991c780f5684e79c39f48390a55f25d4 Mon Sep 17 00:00:00 2001 From: Elena Bolt Date: Tue, 27 Aug 2024 15:39:34 +0200 Subject: [PATCH] README update --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0dd7c99..578c779 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,23 @@ # Preprocessing and encoding analysis pipelines for the encoding of natural speech at the subcortical and cortical level - -## Description - This repository contains the data pipelines described in *Data preprocessing* and *TRF modeling* in our paper entitled *Auditory encoding of natural speech at subcortical and cortical levels is not indicative of cognitive decline*, [doi:10.1523/eNeuro.0545-23.2024](https://doi.org/10.1523/ENEURO.0545-23.2024). We share the code for reasons of transparency. The data—EEG and audio files—cannot be shared, but are available upon request. The code is adapted to our environment and data infrastructure and cannot be executed without adjustments. -* The required modules that we have used to execute our code can be found in the `environment.yml` file. -* All data paths would have to be adapted to your own data infrastructure. - ## Structure -* The EEG and audio file preprocessing pipelines are located in the `preprocessing` folder. -* In `preprocessing/audio` there is a subfolder called `an_model` which contains the scripts and an additional environment (`an_model_environment.yml`) that I needed to generate the speech features (auditory nerve rates) for subcortical analyses. -* The pipeline for the encoding analyses is located in the `encoding` folder. -* Please note that the TRF model is referred to in the scripts as "encoding model" and "encoder" and the regularization parameter λ as "alpha" +- **preprocessing/**: This folder contains the EEG and audio file preprocessing pipelines. + - **preprocessing/audio/**: Within this folder, there is a subfolder called `an_model` which contains the scripts and an additional environment file (`an_model_environment.yml`) needed to generate the speech features (auditory nerve rates) for subcortical analyses. + +- **encoding/**: This folder contains the pipeline for the encoding analyses. + + - Please note that the TRF model is referred to in the scripts as "encoding model" and "encoder," and the regularization parameter λ is referred to as "alpha." + +![Encoding models and evoked responses obtained through our pipeline.](responses.png) -![Enoding models and evoked responses obtained through our pipeline.](responses.png) +## Environment setup +The `environment.yml` file included in this repository contains the specifications for the conda environment used in this project. Please note that the code is adapted to our environment and data infrastructure and cannot be executed without adjustments. ## Acknowledgments