如何为具有特定版本的 shell 调用的软件编写规则?(例如Samtools 1.3.1和0.1.18)



>关于如何解释可以使用需要(略微(不同shell调用的软件版本的管道的想法?

有时,在使用 conda 的版本之间切换时,shell 调用是不同的,例如 Samtools 0.1.18 和 Samtools 1.3.1 需要不同的前缀格式。

我想到了三种方法,并正在寻找其他建议:

  1. 我将在我的 YAML 中添加一个配置变量,使用它来设置版本号。具有条件,以便仅包含匹配的版本规则。类似于我在这里使用软件选择标志的方式。

  2. 我将在规则内进行版本检测,并相应地更改 shell 调用。在上面的例子中,唯一的区别是添加了"-T"参数。这很简单,但我担心最终我会达到一个情况,即它不仅仅是一个额外的论点。

  3. 编写完全独立的规则,在规则名称中使用版本,让用户有责任选择正确的版本。这将不可避免地引起歧义冲突,但我可以处理这些冲突。

反思:我不相信嵌套条件是最好的方法,因为它使维护更加困难,而且它真的不是那么优雅。在规则中进行检测并不是那么糟糕,但我不喜欢将控制流推入规则的想法(现在它已从我的管道的规则中删除(。我想避免产生歧义冲突。

我是否缺少支持功能?起初我以为这是Snakemake的"版本"指令,但实际上并不是我想要的。要么这样,要么我错过了如何使用它。

思潮?

支持文档

萨姆工具 1.3.1

(CentOS5-Compatible) [tboyarski@login3 bin]$ ./samtools sort
Usage: samtools sort [options...] [in.bam]
Options:
-l INT     Set compression level, from 0 (uncompressed) to 9 (best)
-m INT     Set maximum memory per thread; suffix K/M/G recognized [768M]
-n         Sort by read name
-o FILE    Write final output to FILE rather than standard output
-T PREFIX  Write temporary files to PREFIX.nnnn.bam
-@, --threads INT
Set number of sorting and compression threads [1]
--input-fmt-option OPT[=VAL]
Specify a single input file format option in the form
of OPTION or OPTION=VALUE
-O, --output-fmt FORMAT[,OPT[=VAL]]...
Specify output format (SAM, BAM, CRAM)
--output-fmt-option OPT[=VAL]
Specify a single output file format option in the form
of OPTION or OPTION=VALUE
--reference FILE
Reference sequence FASTA FILE [null]

1.3.1 ---> config["samtools"] + ' sort -no -m ' + str(config["sortMem"]( + ' - -T' + str(log.stdErr(

三木 0.1.18

(CentOS5-Compatible) [tboyarski@login3 condaENV]$ samtools sort
Usage: samtools sort [-on] [-m <maxMem>] <in.bam> <out.prefix>

0.1.18 --> config["samtools"] + ' sort -no -m ' + str(config["sortMem"]( + ' - ' + str(log.stdErr(

区别在于 str(log.stdErr( 之前的 '-T'。

我将选择选项 2,使用工具版本作为通配符: 您将将其放在输出文件路径中,这会加强文档,并且如果您想获得与工具不同版本相对应的结果,则可以避免麻烦。

您可以使用通配符函数作为params来确定要传递给shell的部分甚至全部命令。如果未生成整个命令,还可以使用params中的函数来选择正确的工具。

TOOL_VERSIONS = config["tool_versions"]

rule all:
expand("tool_results/{tool_version}/tool_output", tool_version=TOOL_VERSIONS)

rule previous_rule: # I skip this part

def version2tool(wildcards):
if float(wildcards.tool_version) <= 0.1.18:
return "/usr/bin/tool"
else:
return "/usr/local/bin/tool"

def tool_version2options(wildcards):
if float(wildcards.tool_version) <= 0.1.18:
return "-"
else:
return "--T"

rule apply_tool:
input:
rules.previous_rule.output
output:
"tool_results/{tool_version}/tool_output"
params:
tool = version2tool,
tool_options = tool_version2options
shell:
"""
{params.tool} {params.tool_options} {input} > {output}
"""

以上假设您在配置文件中具有所需的版本:

tool_versions : ["0.1.18", "1.3.1"]

相关内容

最新更新