Ploteigen: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Chuck
No edit summary
imported>Jeremy
 
(One intermediate revision by one other user not shown)
Line 22: Line 22:
===Options===
===Options===


'''''options''''' = structure array with the following fields:
* '''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}.
Line 30: Line 31:
===See Also===
===See Also===


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

Latest revision as of 11: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