文档

创建编辑应用

更新时间:

本文介绍如何在工作空间中从头创建和编辑应用。用户可以在从头创建WDL应用,将本地或社区中的WDL应用迁移到基因分析平台中,并且为应用配置常用的分析运行参数。

创建应用

  1. 提供应用基本信息

    • 同一工作空间下的应用名称必须保持唯一,只能由数字、字母、下划线、连接符组成,长度不超过64个字符,且不能以数字或者连接符开头。

    • 目前平台仅支持WDL标准的流程类型应用。

    • 应用版本唯一标签可设置等效于版本编号的版本标签,后续创建任务时可选择使用版本编号或标签。

    image

  2. 编写应用WDL文件

    • 可加载范例作为参考,完整WDL语法请参考官方社区文档

    • 应用必须有且只有一个workflow,作为应用的主文件:

      • 如main.wdl。

    • 用户可以在主文件中定义task,也可以添加更多文件来作为task的输入,并将新增的文件导入主文件中进行使用:

      • 如新增sub.wdl, 并在sub.wdl中定义 task foo。在main.wdl中 import "sub.wdl"后即用使用 foo。

    • task中的runtime部分是定义基因分析应用运行时资源消耗的关键内容,请查看“设置运行时属性”获取帮助。

    r

    说明

    平台会对WDL文件进行语法校验,不通过则会给出相应的错误提示,包含具体的行号和内容。

  3. 添加运行参数(可选)

    • 平台会解析应用内容,自动生成应用的输入参数,作为用户添加运行参数的模板。

    • 用户可以添加多套运行参数,并通过名称和描述信息来说明使用场景。

    • 运行参数必须按照WDL中声明的类型,提供有效的值。

    f

  4. 撰写帮助文档(可选)

    • 版本介绍:该版本的修订信息。

    • 帮助文档:应用的使用帮助,支持使用Markdown语法。

    v

编辑应用

说明

基因分析平台中的应用支持版本化管理,所有版本应用内容均不可更改。编辑指定应用,即为创建该应用的新版本。

  • 创建应用时,如果应用名称已经存在,即为创建/编辑该应用的新版本

  • 工作空间中用户创建的应用版本号由平台自动管理,即从0开始,整数递增,迭代版本数目限制见单应用可修改的版本数

在工作空间的应用列表中,我们可以编辑指定应用:

  • 来源于应用仓库的应用,属于公共应用在工作空间的镜像引用,不支持直接编辑,如需调整公共应用,请使用公共应用WDL代码创建新应用。

  • 用户可选择指定的应用版本进行编辑:

    • 编辑应用时,应用名称无法更改;

    • 编辑应用时,WDL文件展示的是选择的指定版本的内容;

    • 如果新版本的WDL内容无变化,则保留展示指定版本的运行参数;

    • 保存完成后,自动生成新版本号。

image.png

版本打标

点击应用名称进入应用详情页面,点击“版本打标”可对当前选中的应用版本进行添加或修改应用版本唯一标签,标签在该应用的所有版本间将保持唯一性,因此重复打标将自动清除其他版本上的相同标签。后续创建任务或模板时,选择该标签后将自动匹配携带该标签的应用版本。

image

  • 本页导读 (0)