| 5 | | * Add analysis -> Add new analysis |
| 6 | | * push New |
| 7 | | * combine params and data |
| 8 | | * TargetFunctionName MUST match the name of the sourced R function!!! |
| 9 | | * save and test |
| | 5 | === Create a parameter set === |
| | 6 | |
| | 7 | * Similar to creating a ''!DataSet'' definition, you can define a ''!ParameterSet''. |
| | 8 | * |
| | 9 | |
| | 10 | === Add the analysis === |
| | 11 | |
| | 12 | * In the main menu, click ''Add analysis'' and then ''Add new analysis''. |
| | 13 | * Click on ''Add new record''. Give the new analysis a name. |
| | 14 | * Select which ''!DataSet'' and ''!ParameterSet'' you wish to use. Each can be reused individually. |
| | 15 | * Set the !TargetFunctionName. See below. |
| | 16 | * Click ''Add'' to save the new analysis. |
| | 17 | |
| | 18 | === Target function === |
| | 19 | |
| | 20 | * An analysis must have a !TargetFunctionName. This name is used to 'pick out' the R function to be executed when running this analysis. |
| | 21 | * The convention is that any of the defined scripts has a function named 'run_' + !TargetFunctionName. |
| | 22 | * For example: You specify !TargetFunctionName with value 'MYFUNCTION'. When the R api is loaded on execution, the framework will look for a function named 'run_MYFUNCTION' in the stack of sourced scripts. It does not matter if the scripts are part of the framework, or user defined. |
| | 23 | * In the example data, the !TargetFunctionName for Rqtl_analysis is 'QTL'. One of the sourced scripts, 'QTLjob.R', has a function named 'run_QTL'. So one is selected as the target to run. Notice the name of the script, 'QTLjob.R', seems a convention as well. While not strictly the case, naming your script thusly may prevent confusion or error. |
