Nippls: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Jeremy
(Importing text file)
Line 7: Line 7:


:[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')


===Description===
===Description===
Line 14: Line 12:
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
Line 20: Line 18:
* '''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
Line 28: Line 26:
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,

Revision as of 17:34, 3 September 2008

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 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.

See Also

pls, analysis, simpls