Partial least squares correlation (PLSC) for M/EEG
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.
Release files for mne-plsc 0.0.33
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mne_plsc-0.0.33.tar.gz | 29.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mne_plsc-0.0.33-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 57.1 kB
Release files / mne_plsc-0.0.33.tar.gz
| Download URL | mne_plsc-0.0.33.tar.gz |
|---|---|
| Size | 29.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c443cf5cf2b8cedad7a8589ef8d5f7fc62626fa41eb92287a1313082f389b3c4
|
|
BLAKE2b-256 checksum How to use checksums |
2829d4a7d5d6c165c5f3ebf4dfc0bd84018f02bbe7cbec08105195fe4e0327ee
|
| 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.33-py3-none-any.whl
| Download URL | mne_plsc-0.0.33-py3-none-any.whl |
|---|---|
| Size | 27.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
35d31f553773e574e7979a968da2bef9a3dfdfad0458b5a323894056c78b68f1
|
|
BLAKE2b-256 checksum How to use checksums |
1a4da83aa25419e6429c89093f3984497956108d33d4b9aef7da03a398d75aa1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
