https://github.com/computationalpsychiatry/regressiondynamiccausalmodeling.jl

A Julia package for estimating directed connectivity in whole-brain networks

https://github.com/computationalpsychiatry/regressiondynamiccausalmodeling.jl

Science Score: 36.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
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: pubmed.ncbi, ncbi.nlm.nih.gov, sciencedirect.com, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

bayesian-inference brainconnectivity dcm fmri neuroscience statistical-learning
Last synced: 5 months ago · JSON representation

Repository

A Julia package for estimating directed connectivity in whole-brain networks

Basic Info
Statistics
  • Stars: 12
  • Watchers: 1
  • Forks: 2
  • Open Issues: 0
  • Releases: 5
Topics
bayesian-inference brainconnectivity dcm fmri neuroscience statistical-learning
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

Regression Dynamic Causal Modeling (rDCM)

Stable Dev test codecov Code Style: Blue Aqua QA JET DOI

This Julia package implements a variant of dynamic causal modeling (DCM) for fMRI that enables computationally efficient inference on effective (i.e., directed) connectivity parameters among brain regions. Due to its computational efficiency, inversion of large (whole-brain) networks becomes feasible. \ This package is part of TAPAS which is a collection of software tools developed by the Translational Neuromodeling Unit (TNU) and collaborators. The goal of these tools is to support clinical neuromodeling, particularly computational psychiatry, computational neurology, and computational psychosomatics.

Getting started

This package can be installed using Julia's package manager: julia pkg> add RegressionDynamicCausalModeling

Minimal example

The following example shows how to simulate synthetic data with an example DCM and then estimate the posterior of the parameters with rDCM. Based on the estimated parameters one can predict the BOLD signal.

```julia using RegressionDynamicCausalModeling # load the package

dcm = loadexampleDCM() # load the 50 region example DCM

Generate synthetic BOLD data with an SNR of 10

y, , _, _ = generateBOLD(dcm; SNR=10)

Set options for inversion routine

opt = Options(RigidInversionParams();synthetic=true,verbose=1)

Convert the linear DCM to a rDCM model with fixed network architecture

rdcm = RigidRdcm(dcm)

Invert the model (estimate posterior of parameters)

output = invert(rdcm, opt)

Simulate BOLD signal based on estimated parameters

y_pred = predict(rdcm,output) ```

Detailed documentation can be found here.

Some background

The regression dynamic causal modeling (rDCM) package implements a variant of DCM for fMRI (Friston et al., 2003) that enables computationally efficient inference on effective (i.e., directed) connectivity among brain regions. This allows rDCM to scale to larger networks and enables whole-brain effective connectivity analyses. \ rDCM was first introduced in Frässle et al. (2017) and then further extended by incorporating sparsity constraints in Frässle et al. (2018). An extension to resting-state fMRI data has been introduced in Frässle et al. (2021). \ Important note \ The rDCM framework is in an early stage of development and the method is still subject to limitations. Due to these limitations, the requirements of rDCM in terms of fMRI data quality (i.e., fast repetition time (TR), high signal-to-noise ratio (SNR)) are high - as shown in simulation studies (Frässle et al., 2017; 2018). For data that does not meet these conditions, the method might not give reliable results. It remains the responsibility of the user to ensure that his/her dataset fulfills the requirements.

Acknowledgements

This implementation of regression dynamic causal modeling was largely inspired by the original Matlab version.

Citations

Whenever you use a toolbox from TAPAS in your work, please cite the following paper (main TAPAS reference)

  • Frässle, S., Aponte, E.A., Bollmann, S., Brodersen, K.H., Do, C.T., Harrison, O.K., Harrison, S.J., Heinzle, J., Iglesias, S., Kasper, L., Lomakina, E.I., Mathys, C., Müller-Schrader, M., Pereira, I., Petzschner, F.H., Raman, S., Schöbi, D., Toussaint, B., Weber, L.A., Yao, Y., Stephan, K.E., 2021. TAPAS: an open-source software package for Translational Neuromodeling and Computational Psychiatry. Frontiers in Psychiatry 12, 857.

In addition, please cite the following references if you use the rDCM package: - Frässle, S., Lomakina, E.I., Razi, A., Friston, K.J., Buhmann, J.M., Stephan, K.E., 2017. Regression DCM for fMRI. NeuroImage 155, 406-421. - Frässle, S., Lomakina, E.I., Kasper, L., Manjaly Z.M., Leff, A., Pruessmann, K.P., Buhmann, J.M., Stephan, K.E., 2018. A generative model of whole-brain effective connectivity. NeuroImage 179, 505-529.

Finally, when using rDCM for resting-state fMRI data, please also cite: - Frässle, S., Harrison, S.J., Heinzle, J., Clementz, B.A., Tamminga, C.A., Sweeney, J.A., Gershon, E.S., Keshavan, M.S., Pearlson, G.D., Powers, A., Stephan, K.E., 2021. Regression dynamic causal modeling for resting-state fMRI. Human Brain Mapping 42, 2159-2180.

Owner

  • Name: TAPAS
  • Login: ComputationalPsychiatry
  • Kind: organization

GitHub Events

Total
  • Create event: 9
  • Commit comment event: 4
  • Release event: 2
  • Watch event: 9
  • Delete event: 4
  • Issue comment event: 8
  • Push event: 31
  • Pull request event: 14
  • Fork event: 1
Last Year
  • Create event: 9
  • Commit comment event: 4
  • Release event: 2
  • Watch event: 9
  • Delete event: 4
  • Issue comment event: 8
  • Push event: 31
  • Pull request event: 14
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 18 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.33
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 18 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.33
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • JuliaTagBot (1)
Pull Request Authors
  • ImreKertesz (14)
Top Labels
Issue Labels
Pull Request Labels
documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 1 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
juliahub.com: RegressionDynamicCausalModeling

A Julia package for estimating directed connectivity in whole-brain networks

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1 Total
Rankings
Dependent repos count: 3.2%
Average: 9.8%
Dependent packages count: 16.3%
Last synced: 6 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • julia-actions/cache v2 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-docdeploy v1 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/test.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • julia-actions/cache v2 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v2 composite