bbsig

Brain-Body Analysis Special Interest Group (BBSIG)

https://github.com/martager/bbsig

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Brain-Body Analysis Special Interest Group (BBSIG)

Basic Info
  • Host: GitHub
  • Owner: martager
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 4.06 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created 11 months ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Citation

README.md

Brain-Body Analysis Special Interest Group (BBSIG)

Open-access, reproducible pipelines for peripheral physiological signal analysis

BBSIG banner

Dynamic TOML Badge Dynamic TOML Badge Static Badge DOI

What is BBSIG?

BBSIG is a collaborative initiative aimed at streamlining and standardizing the analysis of peripheral physiological data – mainly cardiovascular activity (electrocardiography [ECG], photoplethysmography [PPG]) and respiration – in relation to brain and behavioral data. Our goal is to develop accessible, reproducible, and well-documented analysis pipelines that researchers can integrate into their projects.

We provide a set of open-access, Python-based pipelines, implemented with the modular structure of Jupyter notebooks. After comparing existing open-source packages, such as NeuroKit2 and Systole, we integrated the most suitable functions for peripheral physiological data processing into a recommended sequence of preprocessing and analysis steps, which can be adapted to each research project. Our pipelines are compatible with the Brain Imaging Data Structure (BIDS) specification for file organization and naming conventions.

Our mission is to facilitate and enhance the reproducibility and transparency in peripheral physiological signal analysis by offering open-access, customizable pipelines with step-by-step tutorials. Whether you are a novice or an expert in brain-body interactions, BBSIG provides tools and guidance to support your research.

Current version (v0.0.1)

Currently, BBSIG v0.0.1 includes the following pipelines:

  • Electrocardiography (ECG) preprocessing (ecg_preproc.ipynb): preprocess raw ECG data, including signal cleaning, R-peak detection and QRS complex delineation. Then, export key ECG features such as R-peak and T-wave offset locations, RR intervals time-series and interpolated heart rate (HR), useful for later analysis stages.
  • Photoplethysmography (PPG) preprocessing (ppg_preproc.ipynb): process raw PPG data, including signal normalization, cleaning, clipping artifacts correction and systolic peaks detection. Then, export key PPG information such as systolic peak locations, RR intervals time-series and interpolated heart rate (HR), useful for later analysis stages.
  • Heart Rate Variability (HRV) analysis (hrv_analysis.ipynb): compute time-domain and frequency-domain HRV metrics, starting from the previously preprocessed ECG or PPG data (or from your own RR intervals time-series).

For the full documentation and step-by-step tutorials, visit the Overview page.

Quick setup

In order to run the BBSIG pipelines, we recommend you follow these two quick setup steps:

  1. Create the bbsig_pipeline environment: create a dedicated virtual environment, called bbsig_pipeline, from the provided bbsig_pipeline_environment.yml file. This is based on Python >=3.11 and features a pre-specified collection of packages, including:

    To know more, check our documentation at Create the virtual environment.

  2. Organize your folders and physiological recordings according to the BIDS standards: for optimal compatibility with our pipelines, standardize the folder structure, file naming and file formats of your peripheral physiological data according to the Brain Imaging Data Structure (BIDS) specification. To know more, check our documentation at Organize your BIDS folders.

Citation

When using or adapting the BBSIG pipelines in your research work, please cite us in your publication as:

APA

Gerosa M., Agrawal N., Ciston A.B., Fischer A., Fourcade A., Koushik A., Neubauer M., Patyczek A., Piejka A., Reinwarth E., Roellecke L., Shum Y.H., Verschooren S., Gaebler M. (2025). Brain-Body Analysis Special Interest Group (BBSIG) (Version 0.0.1) [Computer software]. https://doi.org/10.5281/zenodo.15212797

BibTeX

```
@misc{Gerosa_Brain-Body_Analysis_Special_2025,
author = {Gerosa, Marta and Agrawal, Niket and Ciston, Anthony Buck and Fischer, Anna and Fourcade, Antonin and Koushik, Abhay and Neubauer, Mia and Patyczek, Agata and Piejka, Aleksandra and Reinwarth, Elias and Roellecke, Lucy and Shum, Yu Hei and Verschooren, Sam and Gaebler, Michael},
doi = {10.5281/zenodo.15212797},
month = {4},
title = {Brain-Body Analysis Special Interest Group (BBSIG)},
url = {https://github.com/martager/bbsig},
year = {2025}
}
```

To-do:

  • [ ] ECG preprocessing: enable looping over multiple participants (without manual correction)
  • [ ] HRV analysis: solve NeuroKit2's bug in frequency-domain plotting (or develop our own plot)
  • [ ] Make BBSIG into a Python package

Owner

  • Login: martager
  • Kind: user

Citation (CITATION.cff)

cff-version: "1.2.0"
title: "Brain-Body Analysis Special Interest Group (BBSIG)"
version: 0.0.1
license: "MIT"
type: "software"
message: "If you use this software, please cite it as below."
authors:
  - family-names: Gerosa
    given-names: Marta
    orcid: https://orcid.org/0009-0003-6184-8072
  - family-names: Agrawal
    given-names: Niket
    orcid: https://orcid.org/0000-0001-8613-1084 
  - family-names: Ciston
    given-names: Anthony Buck
    orcid: https://orcid.org/0009-0007-5335-5429
  - family-names: Fischer
    given-names: Anna
  - family-names: Fourcade
    given-names: Antonin
    orcid: https://orcid.org/0000-0002-3698-6671
  - family-names: Koushik
    given-names: Abhay
    orcid: https://orcid.org/0000-0002-7181-3215
  - family-names: Neubauer
    given-names: Mia
  - family-names: Patyczek
    given-names: Agata
  - family-names: Piejka
    given-names: Aleksandra
    orcid: https://orcid.org/0000-0002-6122-7845
  - family-names: Reinwarth
    given-names: Elias
  - family-names: Roellecke
    given-names: Lucy
    orcid: https://orcid.org/0009-0007-1442-5228
  - family-names: Shum
    given-names: Yu Hei
    orcid: https://orcid.org/0000-0002-2257-6145
  - family-names: Verschooren
    given-names: Sam
    orcid: https://orcid.org/0000-0002-6391-9861
  - family-names: Gaebler
    given-names: Michael
    orcid: https://orcid.org/0000-0002-4442-5778
date-released: 2025-04-14
identifiers:
  - type: doi
    value: 10.5281/zenodo.15212797 
    description: Zenodo DOI linking to the collection of archived snapshots of all versions of BBSIG
  - type: url
    value: https://github.com/martager/bbsig
    description: URL to the GitHub repository for `BBSIG`
  - type: url
    value: https://martager.github.io/bbsig
    description: URL to the documentation for `BBSIG`
repository-code: https://github.com/martager/bbsig
keywords:
  - peripheral-physiology
  - brain-body-interactions
  - interoception
  - ecg
  - respiration
  - ppg
  - hrv

GitHub Events

Total
  • Release event: 1
  • Watch event: 4
  • Push event: 10
  • Create event: 3
Last Year
  • Release event: 1
  • Watch event: 4
  • Push event: 10
  • Create event: 3

Dependencies

.github/workflows/ci.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
pyproject.toml pypi