Reviewmodel: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Scott
No edit summary
 
(3 intermediate revisions by 2 users not shown)
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.
 
====INPUTS====
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).
* '''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====
 
* '''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.
====Outputs====
*  '''issue''' - the text describing the issue.
 
*  '''color''' - a "color code" identifying the sevrity of the issue.
* '''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.
*  '''issueid''' - a unique ID identifying the issue.
**  '''issue''' : the text describing the issue.
If no outputs are requested, any issues are simply displayed in the''' '''Command Window.
**  '''color''' : a "color code" identifying the severity 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===
===See Also===
[[reviewcrossval]]

Latest revision as of 16:31, 10 June 2014

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 severity 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

reviewcrossval