Question

问题很简单：
我想从规则中调用一个脚本，我希望这个规则同时适用：

执行stdout和stderr重定向
从脚本访问snakemake变量（变量可以是列表和文字）

如果我使用shell:，我可以执行I / O重定向，但我不能在脚本中使用snakemake变量。
注意：当然可以将变量作为shell中的参数传递给脚本。但是，通过这样做，脚本无法区分文字和列表变量。
如果我改为使用script:，那么我可以访问我的snakemake变量，但我无法执行I / O重定向和许多其他shell设施。

举例说明问题：
1）使用shell:

rule create_hdf5:
    input:
        genes_file = OUTPUT_PATH+'/{sample}/outs/genes.tsv'
    params:
        # frequencies is a list!!!
        frequencies = config['X_var']['freqs']
    output:
        HDF5_OUTPUT+'/{sample}.h5'
    log:
        out = LOG_FILES+'/create_hdf5/sample_{sample}.out',
        err = LOG_FILES+'/create_hdf5/sample_{sample}.err'
    shell:
        'python scripts/create_hdf5.py {input.genes_file} {params.frequencies} {output} {threads} 2> {log.err} 1> {log.out} '

问题1）：当然，python脚本认为频率列表中的每个元素都是一个新参数。但是，脚本无法访问snakemake变量。

2）使用script:

rule create_hdf5:
    input:
        genes_file = OUTPUT_PATH+'/{sample}/outs/genes.tsv'
    params:
        # frequencies is a list!!!
        frequencies = config['X_var']['freqs']
    output:
        HDF5_OUTPUT+'/{sample}.h5'
    log:
        out = LOG_FILES+'/create_hdf5/sample_{sample}.out',
        err = LOG_FILES+'/create_hdf5/sample_{sample}.err'
    script:
        'scripts/create_hdf5.py'

问题2）：我可以访问脚本中的snakemake变量。但现在我无法使用I / O重定向等bash工具。

我想知道是否有办法实现两者（也许我错过了snakemake文档中的内容）？提前谢谢！

Answer 1

如果可能，我建议您使用argparse模块来解析脚本的输入，以便它可以使用nargs="*"选项解析参数列表：

def main():
    """Main function of the program."""
    parser = argparse.ArgumentParser(
        description=__doc__,
        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser.add_argument(
        "-g", "--genes_file",
        required=True,
        help="Path to a file containing the genes.")
    parser.add_argument(
        "-o", "--output_file",
        required=True,
        help="Path to the output file.")
    parser.add_argument(
        "-f", "--frequencies",
        nargs="*",
        help="Space-separated list of frequencies.")
    parser.add_argument(
        "-t", "--threads",
        type=int,
        default=1,
        help="Number of threads to use.")
    args = parser.parse_args()
    # then use args.gene_file as a file name and args.frequencies as a list, etc.

你可以这样称呼：

shell:
    """
    python scripts/create_hdf5.py \\
        -g {input.genes_file} -f {params.frequencies} \\
        -o {output} -t {threads} 2> {log.err} 1> {log.out}
    """

Answer 2

您可以使用snakemake.log varaibale在python脚本中访问日志文件名，该列表包含两个文件名：

snakemake.log = [ LOG_FILES+'/create_hdf5/sample_1.out', LOG_FILES+'/create_hdf5/sample_1.err' ]

因此，您可以在脚本中使用它来创建用于记录的日志文件，例如

import logging
mylogger = logging.getLogger('My logger')
# create file handler
fh = logging.FileHandler(snakemake.log[0])
mylogger.addHandler(fh)
mylogger.error("Some error")

snakemake shell I / O重定向和使用脚本访问snakemake变量

2 个答案: