Reviewmodel: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (Importing text file) |
imported>Jeremy (Importing text file) |
||
| Line 1: | Line 1: | ||
===Purpose=== | ===Purpose=== | ||
Examines a standard model structure for typical problems. | Examines a standard model structure for typical problems. | ||
===Synopsis=== | ===Synopsis=== | ||
:[warn,color,warningid] = reviewmodel(model,single) | :[warn,color,warningid] = reviewmodel(model,single) | ||
===Description=== | ===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. | 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==== | ====INPUTS==== | ||
* '''model''' : a standard model structure (or the handle to an Analysis GUI). | * '''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. | * '''single''' : a flag where a value of 1 (one) indicates that only the single most urgent issue should be returned. | ||
====OUTPUTS==== | ====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. | * '''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. | * '''issue''' - the text describing the issue. | ||
* '''color''' - a "color code" identifying the sevrity of the issue. | * '''color''' - a "color code" identifying the sevrity of the issue. | ||
* '''issueid''' - a unique ID identifying the issue. | * '''issueid''' - a unique ID identifying the issue. | ||
If no outputs are requested, any issues are simply displayed in the''' '''Command Window. | If no outputs are requested, any issues are simply displayed in the''' '''Command Window. | ||
===See Also=== | ===See Also=== | ||
Revision as of 15:26, 3 September 2008
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.