Nippls
Jump to navigation
Jump to search
Purpose
NIPALS Partial Least Squares computational engine.
Synopsis
- [reg,ssq,xlds,ylds,wts,xscrs,yscrs,bin] = nippls(x,y,ncomp,options)
Description
Performs PLS regression using NIPALS algorithm.
Inputs
- x = X-block (M by Nx) and
- y = Y-block (M by Ny).
Optional Inputs
- nocomp = number of components {default = rank of X-block}, and
- options = discussed below.
The default options can be retrieved using: options = nippls('options');.
Outputs
- reg = matrix of regression vectors where each row corresponds to a regression vector for a given number of latent variables. If the Y-block contains multiple columns, the rows of reg will be in groups of latent variables (so that the regression vectors for all columns of Y at 1 latent variable will come first, followed by the regression vectors for all columns of Y at 2 latent variables, etc)
- where byn,k is the regression vector for column "n" of the Y-block calculated from "k" latent variables.
- ssq = the sum of squares captured (ssq) with the columns:
- Column 1 = Number of latent variables (LVs)
- Column 2 = Variance captured (as a percent) in the X-block by this LV
- Column 3 = Total variance captured (%) by all LVs up to this row
- Column 4 = Variance captured (as a percent) in the X-block by this LV
- Column 5 = Total variance captured (%) by all LVs up to this row
- xlds = X-block loadings (size: x-block columns by LVs),
- ylds = Y-block loadings (size: y-block columns by LVs),
- wts = X-block weights (size: x-block columns by LVs),
- xscrs = X-block scores (size: samples by LVs),
- yscrs = Y-block scores (size: samples by LVs),
- bin = the inner relation coefficients (size: 1 by LVs).
Options
- options = a structure containing the fields:
- display: [ 'off' |{'on'}], governs display to command window.