Skip to main content

Python implementation of partial least squares correlation (PLSC)

tests codecov

Background

PLSC is a multivariate statistical technique used in neuroscience (McIntosh et al., 1994; McIntosh & Lobaugh, 2004; Krishnan et al., 2011), among other fields. It uses compact singular value decomposition (SVD) to analyze relationships between a multivariate data array and a design matrix. When the object of study is brain-behaviour correlations or functional connectivity, this method is referred to as "behaviour PLSC" or "seed PLSC". In pyplsc, these are implemented by the PLSC model class.

Multivariate categorical differences across experimental conditions can also be analyzed by applying SVD to matrices of condition-wise averages. This approach is called "mean-centred PLSC" or "barycentric discriminant analysis" (BDA; Abdi et al., 2018) and is implemented in pyplsc by the BDA model class.

Finally, associations between continuous variables within participants (e.g., trial-by-trial ratings versus brain data) can be analyzed using within-participants PLSC (Roberts et al., 2016) as implemented in the WPLSC model class.

Installation

pyplsc can be installed from PyPI with:

pip install pyplsc

pyplsc is tested with Python 3.10 and above but may also work with earlier versions.

Usage

pyplsc replicates the statistical functionality of the PLS Matlab package, much like the pyls library. A major difference is that pyplsc uses a scikit-learn-style model-fitting syntax and accepts tabular (pandas.DataFrame) input:

from pyplsc import PLSC, BDA

mod = PLSC(random_state=123)
mod.fit(data=data_array, covariates=cov_table)

Permutation testing and bootstrap resampling are then run as separate steps (possibly in parallel using the n_jobs parameter):

perm_dist = mod.permute(n_perm=1000, n_jobs=3)
boot_dist = mod.bootstrap(n_boot=1000)

In contrast to other PLS implementations, pyplsc does not require data to be pre-sorted by (between-participant) group and (within-participant) condition:

mod = BDA()
mod.fit(data=data_array,
		design=design_matrix_dataframe,
		between='group',
		within='cond',
		participant='subj')

See the documentation for more details and examples.

Download files

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

Source Distribution

pyplsc-0.0.30.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

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

pyplsc-0.0.30-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file pyplsc-0.0.30.tar.gz.

File metadata

  • Download URL: pyplsc-0.0.30.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyplsc-0.0.30.tar.gz
Algorithm Hash digest
SHA256 2c2194fe857a80347cf7e8333846b8840eba92155a617c1b199cd08db6005102
MD5 25b24b5990c8f7ee104eb4601815a944
BLAKE2b-256 cf0edbfe480a48e70b09b3bb2599c4113273e3944178d8ed977b650db4ad49a8

See more details on using hashes here.

File details

Details for the file pyplsc-0.0.30-py3-none-any.whl.

File metadata

  • Download URL: pyplsc-0.0.30-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyplsc-0.0.30-py3-none-any.whl
Algorithm Hash digest
SHA256 2dcab64215dcc37ae59823d67e6cb81aa7e12af2910bba984a890f40f52832ef
MD5 a23d1b1757f7fcb54b274aa3d3fe62ad
BLAKE2b-256 3a97bf66a7b31e92f0c0c4268da89cab35476d0997102726053484d201b45473

See more details on using hashes here.

Supported by

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