Skip to content
 
 

Repository files navigation

PhysPrep workflow

DOI Static Badge Documentation Status Code style: black

Description

Peripheral biosignals are valuable for capturing fluctuations in cognitive and affective states, making it possible to characterize brain-body interactions in neuroimaging setup. The relevance of these measures when acquiring neuroimaging data and the subsequent increase in the amount of data processing highlight the importance of establishing reliable processing and reporting practices for biosignals acquired in magnetic resonance (MR) context, but a standardized head-to-tail workflow has yet to be proposed. Physprep is an open-source tool to prepare biosignals for analysis. This workflow presents itself as user-friendly and flexible by providing customization options through configuration files. The (pre-)processing of cardiac signals (ECG and PPG), electrodermal signals (EDA), and respiratory signals is currently supported.

Quick start

Clone the project and create a virtual environment with Python >=3.9 and <=3.11 !

git clone git@github.com:courtois-neuromod/physprep.git

python3 -m venv <venv_name>
source <venv_name>/bin/activate

cd physprep
pip install .

Contributors

Marie-Eve Picard
Marie-Eve Picard

🤔 💻 ⚠️🚧
François Lespinasse
François Lespinasse

🤔 💻
Elizabeth DuPre
Elizabeth DuPre

🐛
Basile Pinsard
Basile Pinsard

💻

Acknowlegments

Please cite physprep using the Zenodo DOI:

@software{PhysPrep,
    author = {Marie-Eve Picard and François Lespinasse and Elizabeth DuPre and Basile Pinsard},
    license = {Apache-2.0},
    title = {{physprep}},
    url = {https://github.com/courtois-neuromod/physprep/},
    doi = {https://doi.org/10.5281/zenodo.15858672}
}

We also want to give credits to the developers of the libraries on which PhysPrep mainly relies, namely:

🙌 Phys2Bids and the Physiopy community

Please consider citing phys2bids using the Zenodo DOI:

@software{Phys2bids,
    author = {The phys2bids developers},
    license = {Apache-2.0},
    title = {{phy2bids}},
    url = {https://github.com/physiopy/phys2bids},
    doi = {https://doi.org/10.5281/zenodo.3586045}
}

NeuroKit2

Please consider citing neurokit2 using the Zenodo DOI:

@software{Neurokit2,
    author = {Dominique Makowski and Tam Pham and Zen J. Lau and Jan C. Brammer},
    license = {MIT},
    title = {{neurokit2}},
    url = {https://github.com/neuropsychology/NeuroKit/},
    doi = {https://doi.org/10.5281/zenodo.13331945}
}

About

Physiological data preparation workflow adapted for MR settings

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages