Home > Software > Solo_Predictor > Scripting Guide

The following is a quick-reference guide to scripting with Solo_Predictor. For full information on the Solo_Predictor scripting language and for other examples, please see the Solo_Predictor user's manual.

Import of data into object:

obj = 'filename.ext'
obj = 'fully/qualified/path/filename.ext'
obj = 'filename.mat?variable'
obj = '<xml>(PLS_Toolbox XML Format)</xml>'
obj = '3,4,5'

Apply one object to another:

Apply a model object to a data object

result = data|model

Apply a preprocessing object to a data object

result = data|preprocessing

Augment two data objects together

result = data_1|data_2

Fields in "result" will depend on the model and object types.

Return request command:

Return value of object or property of object:

obj
obj.property

Output Format commands:

:xml -set output format to XML
:plain -set output format to plain text
:html -set output format to HTML

Write To File command:

Create output file using a template file for formatting

:writefile 'output.ext' 'template.ext' -append

Optional flag "-append" will append to end of output.ext instead of replacing the file. If 'template.ext' filename is omitted, a template file named 'output.tem' is expected in the same folder as the output file.

The Template file can contain static text and replacement fields using square brackets around return-request-style codes, for example:

"the T-squared value is [pred.t2]"

replacement fields can also contain a formatting code using standard fprintf formatting:

"the Q value is [%0.2e,pred.q]"

Other Commands:

Executes the script in myscript.txt.

:include 'myscript.txt'

Included scripts are executed at the point in the calling script where the include statement occurs. If any errors happen during myscript.txt, all script execution will stop at the include statement. Commands after the include can use objects created within the script (included scripts share the same workspace).

:help Returns list of valid commands
:list Returns list of current objects
:clear Clears all objects

Eigenvector Research, Inc., 3905 West Eaglerock Drive, Wenatchee, WA 98801
B.M. Wise, bmw@eigenvector.com, Phone: 509.662.9213, Fax: 509.662.9214
N.B. Gallagher, nealg@eigenvector.com, Phone: 509.687.1039