Skip to main content

Partial least squares correlation (PLSC) for M/EEG

tests codecov

mne-plsc is a library for partial least squares correlation (PLSC) analysis of M/EEG data in Python, integrated with the MNE-Python library. The basic computations are performed by the pyplsc library, and the documentation of that library contains some background on the PLSC technique.

Installation

mne-plsc can be installed from the Python Package Index with

pip install mne-plsc

Quickstart

The main functions for model fitting are fit_mc, fit_beh, and fit_within_beh. These return objects whose methods can be used for permutation testing, cluster analysis, and visualization. The typical workflow would be:

1. Fit and visualize model

Perform the initial decomposition and check the patterns of saliences.

from mne_plsc import fit_mc
mod = fit_mc(epochs, condition)
mod.plot_lv(0)

2. Permutation testing

Evaluate which latent variables are significant.

mod.permute(1000)
print(model.summary())

3. Cluster analysis

Perform bootstrap resampling to estimate brain salience z-scores, then cluster strong saliences (e.g., $|z| > 2$).

mod.bootstrap(1000)
mod.cluster(threshold=2)

4. Visualize cluster(s)

Examine the temporal/spectral/spatial distribution of the major clusters for a given set of brain saliences.

mod.plot_cluster_sizes(lv_idx=0)
mod.plot_cluster(lv_idx=0, cluster_idx=0)

5. Extract and export data in cluster(s)

For further analysis, we can extract data at cluster peaks (or averages within clusters) and export to a spreadsheet.

df = mod.get_cluster_data(lv_idx=[0, 1, 2], cluster_idx=[0, 1])
df.to_csv('cluster-data.csv')

See the examples in the documentation for more details.

Metadata

Release files for mne-plsc 0.0.32

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

Source distribution (sdist)

Source distribution for mne-plsc 0.0.32
File Size Uploaded
mne_plsc-0.0.32.tar.gz 29.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mne-plsc 0.0.32
File Interpreter ABI Platform
mne_plsc-0.0.32-py3-none-any.whl Python 3 none any Details

Total release size: 57.1 kB

Release files / mne_plsc-0.0.32.tar.gz

Download URL mne_plsc-0.0.32.tar.gz
Size 29.2 kB
Tags Source
SHA-256 checksum
How to use checksums
0d82d2f5acf2a7e1778485a46185aac4015c9bd521155fff450cb63cf938e547
BLAKE2b-256 checksum
How to use checksums
bb98541c049d2e0bbb7c5d41dcad49e5ec11bd9dde1cf1bc2944d00354c0a81e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / mne_plsc-0.0.32-py3-none-any.whl

Download URL mne_plsc-0.0.32-py3-none-any.whl
Size 27.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b277694d23a245d0a4ff9e175853f4198852e1793f3887e85c9cb152db30791f
BLAKE2b-256 checksum
How to use checksums
84e1e1bec9c018394ab4deea1225806e6ba92942fad5ee9f1ee334bb43e00832
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14
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