Plotloads

From Eigenvector Research Documentation Wiki
Revision as of 16:31, 8 October 2008 by imported>Chuck
Jump to navigation Jump to search

Purpose

Extract and display loadings information from a model structure.

Synopsis

a = plotloads(modl,options)
a = plotloads(loads,labels,classes)

Description

Given a standard model structure, relevant loading information (e.g. labels) is collected and passed to plotgui for plotting.

If no output is requested then plotloads initiates an interactive plotting utility to make loadings plots. If an output is requested, no plots are made.

Input

  • modl = a standard model structure, containing loadings to plot; plotloads will extract the loadings, labels and other information for plotting.
  • loads = a N by K loadings matrix (class "double")

Optional Input

  • labels = a character or cell array with N rows containing sample labels
  • classes = a vector with N integer elements of class identifiers.

Output

  • a = a dataset object containing the loadings, labels and other information required for subsequent plotting

Options

options = a structure array with the following fields:

  • display: [ {'on'} | 'off' ], governs level of display,
  • plots: ['none' | 'final' | {'auto'} |], governs plotting behavior, 'auto' makes plots if no output is requested {default}, and
  • 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).

The default options can be retrieved using: options = plotloads('options');.

See Also

analysis, mcr, modelstruct, modelviewer, mpca, pca, pcr, ploteigen, plotgui, plotscores, pls