Reference API

This is the primary reference of pyls. Please refer to the user guide for more information on how to best implement these functions in your own workflows.

List of modules

pyls - PLS decompositions

The primary PLS decomposition methods for use in conducting PLS analyses

pyls.behavioral_pls(X, Y, *[, groups, …])

Performs behavioral PLS on X and Y.

pyls.meancentered_pls(X, *[, groups, …])

Performs mean-centered PLS on X, sorted into groups and conditions.

pyls.structures - PLS data structures

Data structures to hold PLS inputs and results objects

pyls.structures.PLSResults(**kwargs)

Dictionary-like object containing results of PLS analysis

pyls.structures.PLSPermResults(**kwargs)

Dictionary-like object containing results of PLS permutation testing

pyls.structures.PLSBootResults(**kwargs)

Dictionary-like object containing results of PLS bootstrap resampling

pyls.structures.PLSSplitHalfResults(**kwargs)

Dictionary-like object containing results of PLS split-half resampling

pyls.structures.PLSCrossValidationResults(…)

Dictionary-like object containing results of PLS cross-validation testing

pyls.structures.PLSInputs(*args, **kwargs)

PLS input information

pyls.io - Data I/O functionality

Functions for saving and loading PLS data objects

pyls.save_results(fname, results)

Saves PLS results to hdf5 file fname

pyls.load_results(fname)

Load PLS results stored in fname, generated by pyls.save_results()

pyls.matlab - Matlab compatibility

Utilities for handling PLS results generated using the Matlab PLS toolbox

pyls.import_matlab_result(fname[, datamat])

Imports fname PLS result from Matlab