Ploteigen: 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 1: Line 1:
===Purpose===
===Purpose===
Extracts information from a model needed to construct a dataset object for PLOTGUI.
Extracts information from a model needed to construct a dataset object for PLOTGUI.
===Synopsis===
===Synopsis===
:a = ploteigen(modl, ''options'')
:a = ploteigen(modl, ''options'')
===Description===
===Description===
Extracts the variance captured, eigenvalue, and RMSE (root-mean-squared error) information from a model structure for viewing using PLOTGUI. The inputs are a standard model structure, ''modl'', and an optional options structure, ''options'', described below. The output, ''a'', is a DataSet object which can be passed to PLOTGUI for viewing.
Extracts the variance captured, eigenvalue, and RMSE (root-mean-squared error) information from a model structure for viewing using PLOTGUI. The inputs are a standard model structure, ''modl'', and an optional options structure, ''options'', described below. The output, ''a'', is a DataSet object which can be passed to PLOTGUI for viewing.
===Options===
===Options===
* '''plots''': [ 'none' | 'final' | {'auto'} ]  governs plotting behavior,  
* '''plots''': [ 'none' | 'final' | {'auto'} ]  governs plotting behavior,  
*  ''''auto'''' makes plots if no output is requested {default}.
*  ''''auto'''' makes plots if no output is requested {default}.
* '''figure''': [ 'off' | {'on'} ], governs level of display to command window.
* '''figure''': [ 'off' | {'on'} ], governs level of display to command window.
===See Also===
===See Also===
[[analysis]], [[modelstruct]], [[pca]], [[pcr]], [[plotgui]], [[plotloads]], [[pls]]
[[analysis]], [[modelstruct]], [[pca]], [[pcr]], [[plotgui]], [[plotloads]], [[pls]]

Revision as of 14:26, 3 September 2008

Purpose

Extracts information from a model needed to construct a dataset object for PLOTGUI.

Synopsis

a = ploteigen(modl, options)

Description

Extracts the variance captured, eigenvalue, and RMSE (root-mean-squared error) information from a model structure for viewing using PLOTGUI. The inputs are a standard model structure, modl, and an optional options structure, options, described below. The output, a, is a DataSet object which can be passed to PLOTGUI for viewing.

Options

  • plots: [ 'none' | 'final' | {'auto'} ] governs plotting behavior,
  • 'auto' makes plots if no output is requested {default}.
  • figure: [ 'off' | {'on'} ], governs level of display to command window.

See Also

analysis, modelstruct, pca, pcr, plotgui, plotloads, pls