流程创建
我们的平台是基于工作流进行任务计算的,所以任何任务的分析必须先创建流程,如果你是从社区订阅的流程,那么可以跳过这一步。如果你订阅的是工具,你需要基于工具,构建分析流程。由于创建任务时,第一步是选取流程,所以如果您只想跑单一的一个工具,也需要将这个工具制作成流程。同样,您可以将多个工具串联在一起,完成复杂流程的制作。我们在项目中点击项目导航栏中的Flow按钮,再点击右侧的Create flow按钮,创建一个新流程。
建流程页面有3个板块需要编辑,流程名称(Flow name) / 流程图(Flow path construction) / 流程描述(Description)。
类型 | 描述 |
---|---|
Flow name | 编辑流程的名称,不能与其他流程重名 |
Flow path construction | 在左侧选择特定版本工具,点击并拖至右侧,连接工具上的端口,完成流程的构建 |
Description | 流程描述,markdown编辑器,可按提供的模板编辑 |
以三个工具为例,我们的 flow name 设置为fastq2bam
。我们的 Flow path construction 构建方式如下图。
这里我们可以看到当工具被拖入右侧画布时,工具两侧会出现端口(port)。这里的端口是输入文件和输出文件一一对应的,是工具暴露给用户用于连线的,表示文件的流向。
对于构建流程来说,用户可以通过端口快速了解工具的输入,输出文件是什么,从而将多个工具串联在一起。点击工具左侧端口拖拽至空白处,表示端口需要文件输入,点击工具右侧端口拖拽至空白处,表示端口文件会被最终输出。
工具A与工具B之间的连线代表,A工具的输出文件,将被作为B工具的输入文件,此时需要注意的是A工具输出文件的文件格式要满足B工具输入文件格式的要求。
工具A与工具B之间的连线仅代表文件从A工具流向B工具,并不会作为流程的最终输出,如果您想让该文件输出,您可以在工具A的输出文件端口再拖拽一条线,不连接到任何工具,这时它将被系统识别,并作为最终输出文件输出。
我们也可以创建一个相对复杂的流程
构建完流程图之后,如果您还需要对特定的工具参数进行修改,您还可以点击画布中特定工具的图标,点击设置图标,在弹框中进一步工具进行配置。这里主要是配置工具的参数项以及每个工具所需要的计算资源,你可以根据作者的说明进行调整,不调整即按默认参数进行分析。
以下是工具配置项目中的字段说明:
类型 | 描述 |
---|---|
顶部说明 | 工具的使用说明 |
CMD | 工具运行时的命令行(如何制作一个工具中有详细描述,如果只运行工具可不做了解) |
param list | 参数列表,包含输入输出信息以及工具参数 |
prefix | 在命令行中的是否有前缀(如何制作一个工具中有详细描述,如果只运行工具可不做了解) |
type | 数据类型,数字(Number),字符串(String),输入文件(Input),输出文件(Output) |
key | 参数的描述,唯一性,不可重复,一般在说明中通过key告诉用户参数的功能以及如何设置 |
value | 参数设置,用户可以进行修改(Number和String)类型 |
is select | 是否在运行工具时需要该参数,打勾表示需要,必须参数一定会打勾,对于标识性参数,可以通过这个选项判断是否需要该参数 |
input / output | 输入文件 / 输出文件 |
dir | 输入/输出文件在docker中放置的子文件夹位置(如何制作一个工具中有详细描述,如果只运行工具可不做了解) |
port | 端口名字,在流程图中显示的端口的名字,告知用户这个端口需要输入/输出的文件内容 |
type | 文件类型,item表示单个文件输入/输出,array表示这个端口可以同时输入/输出多个文件 |
pattern | 文件后缀,如.csv表示只支持csv文件格式的输入/输出。表示支持任意文件格式输入/输出 |
Computer selection | 该docker工具所需要的计算资源 |
CPU | CPU个数 |
RAM | 最大内存依赖 |
DISK | 最大磁盘存储 |