[[TracNav(xQTL)]]

= [wiki:xQTL xQTL workbench] - Setup a new runnable analysis =

=== Create a parameter set ===

* Similar to creating a ''!DataSet'' definition, you can define a ''!ParameterSet''.
* 

=== Add the analysis ===

* In the main menu, click ''Add analysis'' and then ''Add new analysis''.
* Click on ''Add new record''. Give the new analysis a name.
* Select which ''!DataSet'' and ''!ParameterSet'' you wish to use. Each can be reused individually.
* Set the !TargetFunctionName. See below.
* Click ''Add'' to save the new analysis.

=== Target function ===

* An analysis must have a !TargetFunctionName. This name is used to 'pick out' the R function to be executed when running this analysis.
* The convention is that any of the defined scripts has a function named 'run_' + !TargetFunctionName.
* 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.
* 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.