Plotloads: Difference between revisions
imported>Jeremy (Importing text file) |
imported>Jeremy (Importing text file) |
||
| Line 11: | Line 11: | ||
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, and the output a is a dataset object containing the loadings and labels, etc. | 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, and the output a is a dataset object containing the loadings and labels, etc. | ||
===Options=== | ===Options=== | ||
* ''options'' = a structure array with the following fields: | * '''''options''''' = a structure array with the following fields: | ||
* display: [ {'on'} | 'off' ], governs level of display, | * '''display''': [ {'on'} | 'off' ], governs level of display, | ||
* plots: ['none' | 'final' | {'auto'} |], governs plotting behavior, 'auto' makes plots if no output is requested {default}, and | * '''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). | * '''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 retreived using: options = plotloads('options');. | The default options can be retreived using: options = plotloads('options');. | ||
===See Also=== | ===See Also=== | ||
[[analysis]], [[modelstruct]], [[pca]], [[pcr]], [[plotgui]], [[plotscores]], [[pls]] | [[analysis]], [[modelstruct]], [[pca]], [[pcr]], [[plotgui]], [[plotscores]], [[pls]] | ||
Revision as of 20:57, 2 September 2008
Purpose
Extract and display loadings information from model.
Synopsis
- a = plotloads(modl,options)
- a = plotloads(loads,labels,classes)
- options = plotloads('options')
Description
Given a standard model structure, relevant loading information (e.g. labels) is collected and passed to PLOTGUI for plotting. The input is the model containing loadings to plot modl. (e.g. see MODELSTRUCT). Optional input options is discussed below. Input loads is a N by K loadings matrix (class "double"). Optional input labels is a character or cell array with N rows containing sample labels, and optional input classes is a vector with N integer elements of class identifiers.
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, and the output a is a dataset object containing the loadings and labels, etc.
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 retreived using: options = plotloads('options');.
See Also
analysis, modelstruct, pca, pcr, plotgui, plotscores, pls