Skip to main content

Confound-Corrected Connectome-based Predictive Modeling Python Package

Project description

GitHub Workflow Status Coverage Status Github Contributors Github Commits

Confound-Corrected Connectome-Based Predictive Modelling in Python

Confound-Corrected Connectome-Based Predictive Modelling is a Python package for performing connectome-based predictive modeling (CPM). This toolbox is designed for researchers in neuroscience and psychiatry, providing robust methods for building predictive models based on structural or functional connectome data. It emphasizes replicability, interpretability, and flexibility, making it a valuable tool for analyzing brain connectivity and its relationship to behavior or clinical outcomes.


What is Connectome-Based Predictive Modeling?

Connectome-based predictive modeling (CPM) is a machine learning framework that leverages the brain's connectivity patterns to predict individual differences in behavior, cognition, or clinical status. By identifying key edges in the connectome, CPM creates models that link connectivity metrics with target variables (e.g., clinical scores). This approach is particularly suited for studying complex relationships in neuroimaging data and developing interpretable predictive models.


Key Features

  • Univariate Edge Selection: Supports methods like pearson, spearman, and their partial correlation counterparts, with options for p-threshold optimization and FDR correction.
  • Cross-Validation: Implements nested cross-validation for robust model evaluation.
  • Edge Stability: Selects stable edges across folds to improve model reliability.
  • Confound Adjustment: Controls for covariates during edge selection and modeling.
  • Permutation Testing: Assesses the statistical significance of models using robust permutation-based methods.

Documentation

For detailed instructions on installation, usage, and advanced configurations, visit the documentation website.


Installation

Install the package from GitHub:

git clone https://github.com/mmll/confound_corrected_cpm.git
cd cpm_python
pip install .

Quick Example

Here's a quick overview of how to run a CPM analysis:

from src.cccpm.cpm_analysis import CPMRegression
from src.cccpm.edge_selection import UnivariateEdgeSelection, PThreshold
from sklearn.model_selection import KFold

# Configure edge selection
univariate_edge_selection = UnivariateEdgeSelection(
    edge_statistic=["pearson"],
    edge_selection=[PThreshold(threshold=[0.05], correction=["fdr_by"])]
)

# Create the CPMRegression object
cpm = CPMRegression(
    results_directory="results/",
    cv=KFold(n_splits=10, shuffle=True, random_state=42),
    edge_selection=univariate_edge_selection,
    n_permutations=100
)

# Run the analysis
X = ...  # Connectome data
y = ...  # Target variable
covariates = ...  # Covariates
cpm.run(X, y, covariates)

Contributing

Contributions are welcome! If you have ideas, feedback, or feature requests, feel free to open an issue or submit a pull request on the GitHub repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cccpm-0.2.1.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cccpm-0.2.1-py3-none-any.whl (56.4 kB view details)

Uploaded Python 3

File details

Details for the file cccpm-0.2.1.tar.gz.

File metadata

  • Download URL: cccpm-0.2.1.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cccpm-0.2.1.tar.gz
Algorithm Hash digest
SHA256 0ab6f5416a38caf47f297df6399b0dfc7968357cdbd037cfffea11e9df9c4539
MD5 e85fbaff8c25886923c3ddb7881dadc5
BLAKE2b-256 563d8d1b117805d1ce73832370eb50c38fc90ef505972c8da288b8029fbdf91a

See more details on using hashes here.

Provenance

The following attestation bundles were made for cccpm-0.2.1.tar.gz:

Publisher: publish.yml on wwu-mmll/confound_corrected_cpm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cccpm-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: cccpm-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 56.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cccpm-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c24aaf1f2c6b73964271ff9f7a61882cf827ca1fa1e724ac009c28c3c8aabd84
MD5 d134e56ad62f53edb6f029fa3b046eb8
BLAKE2b-256 2d67a170da5a21a20fa5e2271c210398dadb115b1dd7ba19899f7d9d3adf0075

See more details on using hashes here.

Provenance

The following attestation bundles were made for cccpm-0.2.1-py3-none-any.whl:

Publisher: publish.yml on wwu-mmll/confound_corrected_cpm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page