How to write a result processor.
A result processor is simply a HyPhy batch file. For examples on how they may be designed,
refer to existing modules, which can be found in "TemplateBatchFiles", with names beginning in "post".
How to add a result processing module to the list of available modules..
At startup, HyPhy scans the file "TemplateBatchFiles/postprocessors.lst".
This is a text file, where each line has the form:
"Description String","File Name", "Condition to Execute";
-
Description String: is the name of the processor - it will appear in the choice list.
If it is equal to SEPARATOR, then a menu separator line is inserted.
-
File Name: is the path to the file (relative to "postprocessors.lst") which contains the code
for the processor. It is a good idea to put all result processors inside "TemplateBatchFiles".
-
Condition to Execute: after a template batch file (aka a standard analysis) finished executing,
HyPhy will evaluate this condition, and enable the result processor only if the condition evaluates to a non-zero value.
Add an appropriate line to "postprocessors.lst" of the above format to include a custom result processing module in the list of all available modules.
|