zeigar / nibetaseries

Nipype implementation of BetaSeries Correlations (Alpha)

NiBetaSeries

docs
tests
package

NiBetaSeries is BIDS-compatible application that calculates betaseries correlations. In brief, a beta coefficient is calculated for each trial (or event) resulting in a series of betas that can be used to correlate regions of interest with each other.

NiBetaSeries takes preprocessed data as input that satisfy the BIDS deriviatives specification. In practical terms, NiBetaSeries uses the output of fmriprep, a great BIDS-compatible preprocessing tool. NiBetaSeries requires the input and the atlas to already be in MNI space since currently no transformations are applied to the data. You can use any arbitrary atlas as long as it is in MNI space (the same space as the preprocessed data).

With NiBetaSeries you can receive:

• betaseries images (TODO)
• correlation matrices

This is a very young project that still needs some tender loving care to grow. That's where you fit in! If you would like to contribute, please read our code of conduct and contributing page.

This project heavily leverages nipype, nilearn, pybids, and nistats for development. Please check out their pages and support the developers.

• Free software: MIT license

Installation

pip install nibetaseries

Documentation

https://nibetaseries.readthedocs.io

If you're interested in contributing to this project, here are some guidelines for contributing. Another good place to start is by checking out the open issues.

Development

To run the all tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox