Release Notes Solo Predictor Version 2 3 and Evriscript: Difference between pages
imported>Jeremy (Created page with '==Changes and Bug Fixes in Version 2.3== ===High-level Changes=== * Updated to be compatible with PLS_Toolbox/Solo 6.0 * Add ability to '''[[Solo_Predict…') |
imported>Donal (Created page with '===Purpose=== EVRISCRIPT objects allow calling various PLS_Toolbox operations in an object-oriented way. A script can contain one or more steps, each of which is a separate obje…') |
||
| Line 1: | Line 1: | ||
== | ===Purpose=== | ||
EVRISCRIPT objects allow calling various PLS_Toolbox operations in an | |||
object-oriented way. A script can contain one or more steps, each of | |||
which is a separate object with its own inputs and outputs. Each step is | |||
defined by a keyword which represents the type of step (known as a | |||
module) to perform. | |||
=== | ===Synopsis=== | ||
:myscript = evriscript(keyword,keyword,...); % create a script with two or more steps | |||
===Description=== | |||
====Creating a script==== | |||
Call evriscript with parameters indicating the sequence of steps to | |||
perform, each step indicated by its keyword. The list of available | |||
step keywords is given by the command: evriscript_module('showall') | |||
Example, myscript = evriscript( 'pls', 'crossval', 'choosecomp', 'pls'); | |||
evriscript(keyword,keyword,...) | |||
'myscript' is an evriscript object. The script steps are evriscript_step | |||
objects which can be accessed by indexing, 'myscript(1)', for example. | |||
The individual steps' properties are then configured. Most steps have | |||
more than one 'step_mode', for example 'calibrate', 'apply' or 'test'. | |||
You can see which step_modes are avaialable for a step by entering | |||
myscript(1).step_module. | |||
This also shows the required and optional properties associated with the | |||
step for each step_mode. The 'calibrate' step_mode lists required | |||
properties as: 'x', 'y', and 'ncomp'. | |||
Revision as of 15:36, 16 November 2010
Purpose
EVRISCRIPT objects allow calling various PLS_Toolbox operations in an object-oriented way. A script can contain one or more steps, each of which is a separate object with its own inputs and outputs. Each step is defined by a keyword which represents the type of step (known as a module) to perform.
Synopsis
- myscript = evriscript(keyword,keyword,...); % create a script with two or more steps
Description
Creating a script
Call evriscript with parameters indicating the sequence of steps to perform, each step indicated by its keyword. The list of available step keywords is given by the command: evriscript_module('showall') Example, myscript = evriscript( 'pls', 'crossval', 'choosecomp', 'pls');
evriscript(keyword,keyword,...)
'myscript' is an evriscript object. The script steps are evriscript_step objects which can be accessed by indexing, 'myscript(1)', for example.
The individual steps' properties are then configured. Most steps have more than one 'step_mode', for example 'calibrate', 'apply' or 'test'. You can see which step_modes are avaialable for a step by entering myscript(1).step_module. This also shows the required and optional properties associated with the step for each step_mode. The 'calibrate' step_mode lists required properties as: 'x', 'y', and 'ncomp'.