Evriscript: Difference between revisions
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…') |
imported>Donal No edit summary |
||
| Line 6: | Line 6: | ||
defined by a keyword which represents the type of step (known as a | defined by a keyword which represents the type of step (known as a | ||
module) to perform. | module) to perform. | ||
===Description=== | ===Description=== | ||
| Line 17: | Line 13: | ||
step keywords is given by the command: evriscript_module('showall') | step keywords is given by the command: evriscript_module('showall') | ||
Example, myscript = evriscript( 'pls', 'crossval', 'choosecomp', 'pls'); | Example, myscript = evriscript( 'pls', 'crossval', 'choosecomp', 'pls'); | ||
evriscript(keyword,keyword,...) | myscript = evriscript(keyword,keyword,...); % create a script with two or more steps | ||
'myscript' is an evriscript object. The script steps are evriscript_step | 'myscript' is an evriscript object. The script steps are evriscript_step | ||
Revision as of 14:37, 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.
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');
myscript = evriscript(keyword,keyword,...); % create a script with two or more steps
'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'.