Nippls: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (Importing text file) |
imported>Jeremy (Importing text file) |
||
| Line 1: | Line 1: | ||
===Purpose=== | ===Purpose=== | ||
NIPALS Partial Least Squares computational engine. | NIPALS Partial Least Squares computational engine. | ||
===Synopsis=== | ===Synopsis=== | ||
:[reg,ssq,xlds,ylds,wts,xscrs,yscrs,bin] = nippls(x,y,''ncomp,options'') | :[reg,ssq,xlds,ylds,wts,xscrs,yscrs,bin] = nippls(x,y,''ncomp,options'') | ||
:options = nippls('options') | :options = nippls('options') | ||
===Description=== | ===Description=== | ||
Performs PLS regression using NIPALS algorithm. | Performs PLS regression using NIPALS algorithm. | ||
====INPUTS==== | ====INPUTS==== | ||
* '''x''' = X-block (''M'' by ''Nx'') and | * '''x''' = X-block (''M'' by ''Nx'') and | ||
* '''y''' = Y-block (''M'' by ''Ny''). | * '''y''' = Y-block (''M'' by ''Ny''). | ||
====OPTIONAL INPUTS==== | ====OPTIONAL INPUTS==== | ||
* '''''nocomp''''' = number of components {default = rank of X-block}, and | * '''''nocomp''''' = number of components {default = rank of X-block}, and | ||
*'''''''' options'' = discussed below. | *'''''''' options'' = discussed below. | ||
The default options can be retreived using: options = nippls('options');. | The default options can be retreived using: options = nippls('options');. | ||
====OUTPUTS==== | ====OUTPUTS==== | ||
* '''reg''' = matrix of regression vectors, | * '''reg''' = matrix of regression vectors, | ||
* '''ssq''' = the sum of squares captured (ssq), | * '''ssq''' = the sum of squares captured (ssq), | ||
* '''xlds''' = X-block loadings, | * '''xlds''' = X-block loadings, | ||
* '''ylds''' = Y-block loadings, | * '''ylds''' = Y-block loadings, | ||
* '''wts''' = X-block weights, | * '''wts''' = X-block weights, | ||
* '''xscrs''' = X-block scores, | * '''xscrs''' = X-block scores, | ||
* '''yscrs''' = Y-block scores, and | * '''yscrs''' = Y-block scores, and | ||
* '''bin''' = the inner relation coefficients. | * '''bin''' = the inner relation coefficients. | ||
Note: The regression matrices are ordered in reg such that each ''Ny'' (number of y variables) rows correspond to the regression matrix for that particular number of latent variables. | Note: The regression matrices are ordered in reg such that each ''Ny'' (number of y variables) rows correspond to the regression matrix for that particular number of latent variables. | ||
===Options=== | ===Options=== | ||
* '''''options''''' = a structure containing the fields: | * '''''options''''' = a structure containing the fields: | ||
* '''display''': [ 'off' |{'on'}], governs display to command window. | * '''display''': [ 'off' |{'on'}], governs display to command window. | ||
===See Also=== | ===See Also=== | ||
[[pls]], [[analysis]], [[simpls]] | [[pls]], [[analysis]], [[simpls]] | ||
Revision as of 14:26, 3 September 2008
Purpose
NIPALS Partial Least Squares computational engine.
Synopsis
- [reg,ssq,xlds,ylds,wts,xscrs,yscrs,bin] = nippls(x,y,ncomp,options)
- options = nippls('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 retreived using: options = nippls('options');.
OUTPUTS
- reg = matrix of regression vectors,
- ssq = the sum of squares captured (ssq),
- xlds = X-block loadings,
- ylds = Y-block loadings,
- wts = X-block weights,
- xscrs = X-block scores,
- yscrs = Y-block scores, and
- bin = the inner relation coefficients.
Note: The regression matrices are ordered in reg such that each Ny (number of y variables) rows correspond to the regression matrix for that particular number of latent variables.
Options
- options = a structure containing the fields:
- display: [ 'off' |{'on'}], governs display to command window.