Skip to main content

RABIES: Rodent Automated Bold Improvement of EPI Sequences.

RABIES is an open source image processing pipeline for rodent fMRI. It conducts state-of-the-art preprocessing and confound correction, and supplies standard resting-state functional connectivity analyses. Visit our documentation at https://rabies.readthedocs.io/en/latest/.

RABIES Schema

What you can do with RABIES

The primary purpose of RABIES is to provide rodent fMRI research with a standard, flexible, and reliable image processing platform. The package is complemented with informative data diagnostic features for confound characterization and encourages best practices for quality control and reproducibility. The RABIES software is structured into three main processing stages: preprocessing, confound correction and analysis.

Preprocessing

The preprocessing workflow regroups essential fMRI preprocessing steps prior to analysis. It includes a robust registration workflow with automatically-adapting parameters allowing to succesfully process diverse acquisition types (i.e. rodent species, scan field strength, coil type, ...), and can conduct the following preprocessing steps:

  • head motion correction
  • susceptibility distortion correction
  • resampling to native or common space
  • slice timing correction (optional)
  • despiking (optional)
  • visual assessment of registration for quality control

Confound correction

Following preprocessing, RABIES provides a highly-customizable confound correction pipeline regrouping several common strategies:

  • frame censoring (or scrubbing)
  • confound regression (with several options for nuisance regressors)
  • frequency filtering (highpass, lowpass, bandpass)
  • ICA-AROMA
  • spatial smoothing

Analysis

Simple resting-state connectivity analyses are made available after preprocessing and confound correction:

  • seed-based functional connectivity
  • whole-brain connectivity matrix
  • group-ICA
  • dual regression

Importantly, the analysis stage is also complemented by a data quality assessment report (executed with --data_diagnosis), which generates several indices of data quality and potential confounds, with the aim of improving preprocessing strategies, data interpretation and scientific transparency.

Notes on software design

Nipype workflows: The image processing pipelines are structured using the Nipype library, which allows to build dynamic workflows in the form of a computational graph. Each node in the graph consists of a processing step, and the required inputs/outputs define the links between nodes. In addition to supporting code organization, Nipype workflows also handle several plugin architectures for parallel execution as well as memory management. The computational time to run the entire RABIES pipeline will vary substantially depending on data size, but for most uses, it will range from a few hours to a day when using proper computational resources and parallel execution.

Reproducible and transparent research: RABIES aims to follow best practices for reproducible and transparent research, including the following:

  • open source code https://github.com/CoBrALab/RABIES
  • standardized input data format with BIDS
  • easily shared, automatically-generated visual outputs for quality control
  • containerized distribution of the software through Docker/Apptainer, and conveniently installed from our Github or Docker Hub servers.

Citation

Citing RABIES: Please cite the official publication Desrosiers-Grégoire, et al. Nat Commun 15, 6708 (2024). when referencing the software.

Boilerplate: a boilerplate summarizing the preprocessing and confound correction operations is automatically generated in the output folder. You can use the boilerplate to help describe your methods in a paper.

License

The RABIES license allows for uses in academic and educational environments only. Commercial use requires a commercial license from CoBrALab contact@cobralab.ca, http://cobralab.ca

Acknowledgements

This software was developed by the CoBrALab, located at the Cerebral Imaging Center of the Douglas Mental Health University Institute, Montreal, Canada, in affiliation with McGill University, Montreal, Canada. This work was supported by funding from Healthy Brains, Healthy Lives (HBHL), the Fonds de recherche du Québec - Santé (FRQS) and - Nature et technologies (FRQNT), and the Natural Sciences and Engineering Research Council (NSERC) of Canada. fMRIPrep was an important inspirational source for this project, in particular with regards to best practices for software reproducibility and code design using Nipype. We also thank the organizers of BrainHack School Montreal, which guided the initial steps of this project in 2018.

Ask for help

If you need support in using the software or experience issues that are not documented, we'll provide support on the Github discussion.

Metadata

Release files for rabies 0.6.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rabies 0.6.2
File Size Uploaded
rabies-0.6.2.tar.gz 202.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rabies 0.6.2
File Interpreter ABI Platform
rabies-0.6.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 431.1 kB

Release files / rabies-0.6.2.tar.gz

Download URL rabies-0.6.2.tar.gz
Size 202.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0133fcdb4322ce51291f71bc1942d85ac080dde988f1f21344b33e99ef44fcc5
BLAKE2b-256 checksum
How to use checksums
fa126058b84f6a6588b2b838d1e1481fd98cd553240d5e3a67d827ba1eac3fa7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / rabies-0.6.2-py2.py3-none-any.whl

Download URL rabies-0.6.2-py2.py3-none-any.whl
Size 228.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
77c2bf187c6c61c18b696218fd98a9b11bb9e5737b127348a20c0236fc6dfabf
BLAKE2b-256 checksum
How to use checksums
14b4e822746d2c90bc08bdf6a89941dd316b3bf3ed6aa95a57216912b1dededc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

0.6.2 This release

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.3

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page