PLS_Toolbox Documentation: reviewmodel	< reversebytes	ridge >

reviewmodel

Purpose

Examines a standard model structure for typical problems.

Synopsis

[warn,color,warningid] = reviewmodel(model,single)

Description

Given a standard PLS_Toolbox model structure, REVIEWMODEL examines the numerical and build information and returns textual warnings to advise the user of possible issues.

INPUTS:

                   model :   a standard model structure (or the handle to an Analysis GUI).

                    single :   a flag where a value of 1 (one) indicates that only the single most urgent issue should be returned.

OUTPUTS:

                    issues :   A structure array containing one or more issues identified in the model. The structure contains the following fields and may contain one or more records, or may be empty if no issues were identified.

                                 issue - the text describing the issue.

                                 color - a "color code" identifying the sevrity of the issue.

                                 issueid - a unique ID identifying the issue.

If no outputs are requested, any issues are simply displayed in the Command Window.

See Also