snakemake: 基本语法知识点

Snakemake 使用一种基于 Python 的语法来定义工作流，允许用户编写规则（rules）来指定数据分析流程中的各个步骤。以下是一些基础语法知识点，帮助你理解和使用 Snakemake。

1. 规则（Rules）

规则是 Snakemake 工作流的基本构建块，每个规则定义了一个分析步骤。一个规则通常包括输入（input）、输出（output）、执行的命令（shell 或 script）等部分。

rule example:
    input:
        "data/input.txt"
    output:
        "results/output.txt"
    shell:
        "somecommand {input} > {output}"

2. 输入（Inputs）和输出（Outputs）

• 输入（Inputs）: 规则所需的文件或数据。它可以是硬编码的文件名，也可以是由其他规则的输出动态生成的。
• 输出（Outputs）: 规则执行后生成的文件或数据。Snakemake 使用输出文件来确定规则是否需要被执行。

3. Shell 命令（Shell）

Shell 命令是规则中执行的实际命令行指令。你可以使用 {input} 和 {output} 等占位符来引用规则的输入和输出。

4. 通配符（Wildcards）

通配符允许规则被应用于多个文件，而不需要为每个文件单独写规则。Snakemake 会自动匹配并应用规则。

rule all:
    input:
        "results/output_A.txt",
        "results/output_B.txt"

rule process:
    input:
        "data/{sample}.txt"
    output:
        "results/output_{sample}.txt"
    shell:
        "process_data {input} > {output}"

5. 规则依赖（Dependencies）

Snakemake 自动处理规则之间的依赖关系。如果一个规则的输出是另一个规则的输入，Snakemake 会自动先执行依赖规则。

6. 配置文件（Config Files）

配置文件（通常是 YAML 或 JSON 格式）允许你在不修改 Snakefile 的情况下，灵活地改变输入参数或路径。

configfile: "config.yaml"

7. 参数（Params）和日志（Log）

• 参数（Params）: 为规则提供额外的参数，如命令行选项。
• 日志（Log）: 指定日志文件的路径，用于记录规则执行的输出。

rule example:
    input:
        "data/input.txt"
    output:
        "results/output.txt"
    params:
        extra="--verbose"
    log:
        "logs/example.log"
    shell:
        "command {params.extra} {input} > {output} 2> {log}"

8. 脚本和笔记本（Scripts and Notebooks）

Snakemake 允许直接在规则中使用 Python 脚本或 Jupyter 笔记本，而不仅仅是 shell 命令。

rule use_script:
    input:
        "data/input.txt"
    output:
        "results/output.txt"
    script:
        "scripts/process_data.py"

掌握这些基础语法知识点后，你将能够开始构建自己的 Snakemake 工作流。随着实践的增加，你会逐渐熟悉 Snakemake 提供的更多高级特性和最佳实践。