fMRIStroke

fMRIStroke: A preprocessing pipeline for fMRI Data from Stroke patients - Published in JOSS (2024)

https://github.com/alixlam/fmristroke

Science Score: 93.0%

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

  • 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 and JOSS metadata
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Medicine Life Sciences - 88% confidence
Sociology Social Sciences - 87% confidence
Economics Social Sciences - 85% confidence
Last synced: 4 months ago · JSON representation

Repository

Adding quality checks and confounds computation steps to fmriprep for stroke data.

Basic Info
  • Host: GitHub
  • Owner: alixlam
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 174 MB
Statistics
  • Stars: 13
  • Watchers: 1
  • Forks: 3
  • Open Issues: 2
  • Releases: 1
Created about 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License

README.rst

*fMRIStroke*: A preprocessing pipeline for fMRI Data from Stroke patients 
=========================================================================
*fMRIStoke* is a BIDs application that runs on the outputs of *fmriprep*
(`www.fmriprep.org `__) for the preprocessing of
task-based and resting-state functional MRI (fMRI) from stroke patients.

.. image:: https://readthedocs.org/projects/fmristroke/badge/?version=latest
    :target: https://fmristroke.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. image:: https://github.com/alixlam/fmristroke/workflows/Pytest/badge.svg
    :target: https://github.com/alixlam/fmristroke/actions/Pytest
    :alt: github actions pytest
.. image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/alixlam/76065cdb0e28e9ce276f32f5c5ac568f/raw/covbadge.json
    :target: https://github.com/alixlam/fmristroke/actions/CI
    :alt: Python Coverage
.. image:: https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white
  :target: https://hub.docker.com/r/alixlam/fmristroke/tags/
  :alt: Docker image available!

Complete information and documentation can be found at
https://fmristroke.readthedocs.io/

About
-----

.. figure:: https://github.com/alixlam/fmristroke/blob/main/docs/_static/pipeline.png?raw=true
    :target: https://github.com/alixlam/fmristroke/blob/main/docs/_static/pipeline.png

Motivation
~~~~~~~~~~
Stroke not only leads to structural damages of gray/white matter in affected patietns, 
but can also produce remote changes in structurally normal brain areas by a variety of different mechanisms [Siegel2017]_.
As a result, it is highly recommended, notably by [Siegel2017]_, to add specific quality checks and strategies to mitigate lesion specific confounds when dealing with
stroke data especially when doing :abbr:`FC analysis (functional connectivity)`.


To do this we propose *fMRIStroke* a functional magnetic resonance imaging (fMRI) data
quality checks and preprocessing pipeline tailored to stroke data. It is designed to provide an easily accessible,
interface that is robust to variations in scan acquisition
protocols and that requires minimal user input, while providing easily
interpretable and comprehensive reports.
It uses fmriprep (`www.fmriprep.org `_) outputs derivatives to generate
new quality checks plots for stroke patients when lesion masks are available and
computes new confounds like signals in lesion masks, and ICA based confounds (as proposed in [Yourganov2017]_).


Added quality checks: 
~~~~~~~~~~~~~~~~~~~~~
-  **hemodynamics lagmap** using the Rapidtide_ python tool providing output reports on the hemodynamic lags present bold series.
-  **homotopic connectivity** if freesurfer reconstruction was run.
-  **Registration plots with lesion mask**

Added confounds:
~~~~~~~~~~~~~~~

- **lesion**: signal in lesion mask.
- **CSF lesion**: signal in CSF + lesion combined mask.
- **ICA_comp**: ICA based confounds [Yourganov2017]_.


Added outputs:
~~~~~~~~~~~~~~

- **ROI masks** in standardized space.
- **Denoised fMRI**: Denoised BOLD series using the provided pipelines.
- **Functional Connectivity**: Connectivity matrix using provided atlases and connectivity measures.


The *fMRIStroke* pipeline uses a combination of tools from well-known software
packages, including ANTs_,  FreeSurfer_, Rapidtide_ and Nilearn_

.. important::
  This pipeline was designed to run after fmriprep. Any other fMRI preprocessing tools might not provide the required derivatives for fMRIStroke to run properly. 


In summary this tool allows you to easily do the following:

- Generate preprocessing quality reports specific to stroke patients, with which the user can easily
  identify outliers.
- Receive verbose output concerning the stage of preprocessing for each
  subject, including meaningful errors.
- Automate and parallelize processing steps, which provides a significant
  speed-up from manual processing or shell-scripted pipelines.


Citation
--------
**Citation**.




Acknowledgements
----------------
This work makes great use of the work by the `NiPreps Community `__.
and the work done by `rapidtides authors `__. 


References
----------

.. [Siegel2017] J. S. Siegel, G. L. Shulman, and M. Corbetta, Measuring functional connectivity in stroke: Approaches and considerations, J Cereb Blood Flow Metab, 2017.
     doi: `10.1177/0271678X17709198. `_

.. [Yourganov2017] Yourganov, G., Fridriksson, J., Stark, B., Rorden, C., Removal of artifacts from resting-state fMRI data in stroke. Neuroimage Clin 2017.
     doi: `10.1016/j.nicl.2017.10.027 `_

Owner

  • Login: alixlam
  • Kind: user

JOSS Publication

fMRIStroke: A preprocessing pipeline for fMRI Data from Stroke patients
Published
November 20, 2024
Volume 9, Issue 103, Page 6636
Authors
Alix Lamouroux ORCID
IMT Atlantique, Lab-STICC UMR CNRS 6285 F-29238,Brest, France, Univ Rennes, Inria, CNRS, Inserm, Rennes, France
Giulia Lioi ORCID
IMT Atlantique, Lab-STICC UMR CNRS 6285 F-29238,Brest, France
Julie Coloigner ORCID
Univ Rennes, Inria, CNRS, Inserm, Rennes, France
Pierre Maurel ORCID
Univ Rennes, Inria, CNRS, Inserm, Rennes, France
Nicolas Farrugia ORCID
IMT Atlantique, Lab-STICC UMR CNRS 6285 F-29238,Brest, France
Editor
Stefan Appelhoff ORCID
Tags
fMRI preprocessing stroke functional connectivity

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 6
  • Watch event: 9
  • Delete event: 3
  • Issue comment event: 17
  • Push event: 11
  • Pull request event: 6
  • Fork event: 2
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 6
  • Watch event: 9
  • Delete event: 3
  • Issue comment event: 17
  • Push event: 11
  • Pull request event: 6
  • Fork event: 2

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 146
  • Total Committers: 2
  • Avg Commits per committer: 73.0
  • Development Distribution Score (DDS): 0.26
Past Year
  • Commits: 17
  • Committers: 1
  • Avg Commits per committer: 17.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
alixlam 6****m 108
Alix LAMOUROUX a****u@s****r 38
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 9
  • Total pull requests: 17
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 3.89
  • Average comments per pull request: 0.0
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 5
  • Average time to close issues: 6 days
  • Average time to close pull requests: about 5 hours
  • Issue authors: 4
  • Pull request authors: 1
  • Average comments per issue: 5.75
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • SRSteinkamp (5)
  • behinger (2)
  • aiims-himanshu (1)
  • alixlam (1)
Pull Request Authors
  • alixlam (28)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Dependencies

docs/requirements.txt pypi
  • sphinx-argparse *
  • sphinx_rtd_theme *
.github/workflows/draft-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • actions/upload-artifact v3 composite
  • schneegans/dynamic-badges-action v1.6.0 composite
requirements-test.txt pypi
  • autopep8 * test
  • black * test
  • build * test
  • coverage * test
  • importlib_resources * test
  • ipython * test
  • isort * test
  • pycodestyle * test
  • pylint * test
  • pytest * test
  • pytest-cov * test
  • sphinx * test
requirements.in pypi
  • antspyx ==0.3.8
  • fmriprep ==23.0.2
  • rapidtide *
requirements.txt pypi
  • 110 dependencies
setup.py pypi