更新时间:2021-12-08 GMT+08:00
分享

inputs

可选项,用于定义测序流程的可变部分。inputs由多个变量组成,最多可定义60个变量,且每个变量名唯一,若变量名重复,则后面定义的将会覆盖之前定义的。

变量可以在流程文件的其他参数中引用,引用方式采用shell脚本方式,即:${var},其中var为变量名称。

inputs格式

inputs:
  <输入参数名称>:
    type: <类型>
    default: <默认值>
    description: <描述,支持中文>
    label: <标签>
表1 参数属性说明

属性

是否必选

参数类型

参数描述

输入参数名称

String

输入参数名称,由字母、数字和中划线“-”或下划线“_”组成,长度为[1, 20]。

type

String

参数类型,请根据参数类型选择,可选范围如下所示。

  • string,类型为字符串
  • number,类型为数字
  • bool,类型为布尔值
  • array,类型为数组

description

String

参数描述信息,支持中文,长度为[0, 255]。

default

String

参数默认值,按照type填写对应的值。默认值信息可在执行流程时由外部输入替换;若未填写默认值,外部输入将必须填写这个参数的值。

一个变量可以引用另一个变量的值,如:

default: /home/${path_var}
须知:

默认值的类型和定义的参数类型必须统一。

label

String

参数的标签,用于参数分组,便于管理,以便其他使用者理解。

长度为[0, 64],支持中文。

取值如下所示。

  • basic,表示基础配置,显示在控制台“配置”>“通用配置”中。当此参数不设label时,默认配置值为basic
  • 其他值,表示分组名称,显示在控制台“配置”>“高级配置”中。

此处定义的标签可在控制台界面执行时进行分类展示,如下图中的“group_info”即为标签。

inputs配置样例

inputs:
  sample:
    type: string
    default: /home/zhangsan
  split:
    default: 3
    type: number
    label: gatk #为参数分组
分享:

    相关文档

    相关产品