Ploteigen: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Jeremy
 
(3 intermediate revisions by 2 users not shown)
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 subsequent viewing using PLOTGUI.  
 
====Inputs====
 
* '''modl''' = a standard model structure
* '''options''' = an optional options structure, described below.  
 
====Outputs====
 
* '''a''' = a DataSet object which can be passed to [[plotgui]] for viewing.
 
===Options===
===Options===
* '''plots''': [ 'none' | 'final' | {'auto'} ]  governs plotting behavior,
 
* ''''auto'''' makes plots if no output is requested {default}.
'''''options''''' = structure array with the following fields:
* '''figure''': [ 'off' | {'on'} ], governs level of display to command window.
* '''plots''': [ 'none' | 'final' | {'auto'} ]  governs plotting behavior
** ''''auto'''' makes plots if no output is requested {default}.
* '''figure''': [] governs where plots are made
** when figure = [] plots are made in a new figure window {default}
** this can also be a valid figure number (i.e. figure handle).
 
===See Also===
===See Also===
[[analysis]], [[modelstruct]], [[pca]], [[pcr]], [[plotgui]], [[plotloads]], [[pls]]
 
[[analysis]], [[modelstruct]], [[pca]], [[pcr]], [[plotgui]], [[plotloads]], [[plotscores]], [[pls]]

Latest revision as of 12:02, 27 April 2015

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 subsequent viewing using PLOTGUI.

Inputs

  • modl = a standard model structure
  • options = an optional options structure, described below.

Outputs

  • a = a DataSet object which can be passed to plotgui for viewing.

Options

options = structure array with the following fields:

  • plots: [ 'none' | 'final' | {'auto'} ] governs plotting behavior
    • 'auto' makes plots if no output is requested {default}.
  • figure: [] governs where plots are made
    • when figure = [] plots are made in a new figure window {default}
    • this can also be a valid figure number (i.e. figure handle).

See Also

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