模块化之level 1---简单封装
Snakemake包装器存储库是可重复使用包装器的集合,可用于快速使用Snakemake规则和工作流中的流行工具
input:
"mapped/{sample}.bam"
output:
"mapped/{sample}.sorted.bam"
params:
"-m 4G"
threads: 8
wrapper:
"0.2.0/bio/samtools/sort"
在这里,Snakemake将自动从https://bitbucket.org/snakemake/snakemake-wrappers/src/0.2.0/bio/samtools/sort/wrapper.py下载相应的包装器。因此,0.2.0可以替换为您要使用的version标记或commit id。由于包装器实现中的更改不会自动传播到您的工作流程中,因此可确保可重复性。替代地,例如,对于开发而言,包装程序指令还可以指向完整的URL,包括本地URL file://
。
每个包装器都定义必需的软件包和版本。结合--use-conda
Snakemake 的标志,这些将自动部署。
模块化之level2---大型分析流程的整合
对于应集成到通用工作流程中的较大的可重复使用的部件,建议编写小的Snakefile,然后通过include语句将其包含在主Snakefile中。在这种设置中,所有规则都共享一个公共配置文件。
include: "path/to/other/snakefile"
默认的目标规则(通常称为all-rule)不会受到include的影响。也就是说,无论您有多少个包含在第一个规则之上的内容,它始终将是Snakefile中的第一个规则。包含是相对于出现它们的Snakefile目录的。例如,如果以上Snakefile驻留在directory中my/dir,则Snakemake将在处搜索include my/dir/path/to/other/snakefile,而与工作目录无关。
模块化之level 3---构建子工作流程
除了包括其他工作流程的规则外,Snakemake还允许依赖于其他工作流程的输出作为子工作流程。在执行当前工作流程之前,将独立执行子工作流程。因此,Snakemake可以确保在必要时创建或更新当前工作流程所依赖的所有文件。这允许在原本单独的数据分析之间创建链接。
subworkflow otherworkflow:
workdir:
"../path/to/otherworkflow"
snakefile:
"../path/to/otherworkflow/Snakefile"
configfile:
"path/to/custom_configfile.yaml"
rule a:
input:
otherworkflow("test.txt")
output: ...
shell: ...
在这里,子工作流被命名为“ otherworkflow”,它位于工作目录中../path/to/otherworkflow
。snakefile位于同一目录中,并称为Snakefile
。如果snakefile
未为子工作流定义,则假定它位于workdir位置并称为Snakefile
,因此,在上面我们也可以省略snakefile
关键字。如果workdir
未指定,则假定与当前相同。(可选的)定义configfile
允许根据需要参数化子工作流。从我们依赖的子工作流输出的文件将标有otherworkflow
功能(请参见规则a的输入)。此功能自动确定文件的绝对路径(在此处../path/to/otherworkflow/test.txt
)。
在执行时,snakemake首先尝试通过执行子工作流来创建(或更新,如果需要)test.txt
(以及所有其他可能提到的依赖项)。然后执行当前的工作流程。这也可以递归发生,因为子工作流也可能有其自己的子工作流。