Pcrengine: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Chuck
No edit summary
Line 1: Line 1:
===Purpose===
===Purpose===


Line 12: Line 11:
PCRENGINE calculates the basic elements of a PCR model (see PCR).
PCRENGINE calculates the basic elements of a PCR model (see PCR).


Inputs are x the predictor x-block, and y the predicted y-block.


Optional input ''ncomp'' is the number of components to to be calculated (positive integer scalar). If the number of components ''ncomp'' is not specified, the routine will return components up to the rank of the x-block. Optional input ''options''. is discussed below.
Note: The regression matrices are ordered in b such that each ''Ny'' (number of y-block variables) rows correspond to the regression matrix for that particular number of principal components.
 
====Inputs====
 
* '''x''' = the x-block data, and
* '''y''' = the corresponding y-block data.


Outputs are the matrix of regression vectors reg, the sum of squares captured ssq, x-block loadings loads, x-block scores scores, and the PCA ssqtable (pcassq).
====Optional Inputs====


Note: The regression matrices are ordered in b such that each ''Ny'' (number of y-block variables) rows correspond to the regression matrix for that particular number of principal components.
* '''ncomp''' = the number of components to to be calculated (positive integer scalar). If the number of components ''ncomp'' is not specified, the routine will return components up to the rank of the x-block.
* '''options''', which is discussed below.
 
====Outputs====
 
* '''reg''' = the matrix of regression vectors
* '''ssq''' = the sum of squares captured ssq
* '''loads''' =  x-block loadings
* '''scores''' =  x-block scores
* '''pcassq''' =  the PCA sum-of-squares table


===Options===
===Options===


''options'' =  a structure array with the following fields:
'''options''' =  a structure array with the following fields:


* '''display''': [ 'off' | {'on'} ], governs level of display to command window,
* '''display''': [ 'off' | {'on'} ], governs level of display to command window,

Revision as of 14:47, 8 October 2008

Purpose

Principal components regression computational engine.

Synopsis

[reg,ssq,loads,scores,pcassq] = pcrengine(x,y,ncomp,options)

Description

PCRENGINE calculates the basic elements of a PCR model (see PCR).


Note: The regression matrices are ordered in b such that each Ny (number of y-block variables) rows correspond to the regression matrix for that particular number of principal components.

Inputs

  • x = the x-block data, and
  • y = the corresponding y-block data.

Optional Inputs

  • ncomp = the number of components to to be calculated (positive integer scalar). If the number of components ncomp is not specified, the routine will return components up to the rank of the x-block.
  • options, which is discussed below.

Outputs

  • reg = the matrix of regression vectors
  • ssq = the sum of squares captured ssq
  • loads = x-block loadings
  • scores = x-block scores
  • pcassq = the PCA sum-of-squares table

Options

options = a structure array with the following fields:

  • display: [ 'off' | {'on'} ], governs level of display to command window,
  • sortorder: [ {'x'} | 'y' ], governs order of factors in outputs. 'x' is standard PCR sort order (ordered in terms of X block variance captured). 'y' is Correlation PCR sort order (ordered in terms of Y block variance captured).

The default options can be retreived using: options = pcrengine('options');.

See Also

analysis, pcr, pls