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.37

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.37
File Size Uploaded Provenance Actions
mne_plsc-0.0.37.tar.gz 29.9 kB Without provenance Details for mne_plsc-0.0.37.tar.gz

Built distribution (wheel)

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

Total release size: 58.5 kB

Release files / mne_plsc-0.0.37.tar.gz

Download URL mne_plsc-0.0.37.tar.gz
Size 29.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ab8c689a6ba696448b77e23f149e3fa8d9fef6928e2cb33615926bbe1df75c10
BLAKE2b-256 checksum
How to use checksums
58b03b6bb328aaec32f4f0ac4165948314889051aad33815c44a90db9f596136
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

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

Download URL mne_plsc-0.0.37-py3-none-any.whl
Size 28.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9b7dc37850dbc3a88e971ffb9872c4b57dc7e2943186f60fefd79de35c091476
BLAKE2b-256 checksum
How to use checksums
9ab18fe813a2ac1fc827e30759e302793d82b169b0cc92f6c7602cf8a6917dd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for mne-plsc 0.0.37

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.37 This release

2 release files No provenance

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