Parameter templates

You can define input parameters to make your workflow more flexible and versatile. For example, you can define a parameter to be the Amazon S3 location of the reference genome files. Users can then run the workflow using various data sets.

To define the input parameters, create a parameter template JSON file. In the file, each input parameter is a named object that must match the name of the workflow input. The input parameter object includes the following fields:

• A description field. This required field is a string that the service console displays in the Start run page.

• A field named optional. This field indicates whether the input parameter is optional. This field is optional. If you don't specify it, the input parameter is required.

The following example parameter template shows how to specify the input parameters.

{
  "myRequiredParameter1": {
     "description": "this parameter is required",
  },
  "myRequiredParameter2": {
     "description": "this parameter is also required",
     "optional": false
  },
  "myOptionalParameter": {
     "description": "this parameter is optional",
     "optional": true
  }
}   

A workflow written in CWL doesn't require a parameter template. HealthOmics auto-detects all the workflow inputs for CWL workflows.