Bio.Sequencing.Applications 包

模块内容

与测序相关的命令行应用程序包装器（已弃用）。

我们已决定在未来移除此模块，并建议直接通过 subprocess 模块构建您的命令并调用它。

class Bio.Sequencing.Applications.BwaIndexCommandline(cmd='bwa', **kwargs)

基础：AbstractCommandline

Burrows Wheeler Aligner (BWA) 索引的命令行包装器。

索引 FASTA 格式的数据库序列，等效于

$ bwa index [-p prefix] [-a algoType] [-c] <in.db.fasta>

有关详细信息，请参见 http://bio-bwa.sourceforge.net/bwa.shtml。

示例

>>> from Bio.Sequencing.Applications import BwaIndexCommandline
>>> reference_genome = "/path/to/reference_genome.fasta"
>>> index_cmd = BwaIndexCommandline(infile=reference_genome, algorithm="bwtsw")
>>> print(index_cmd)
bwa index -a bwtsw /path/to/reference_genome.fasta

您通常会使用 index_cmd() 或通过 Python subprocess 模块运行该命令，如 Biopython 教程中所述。

__init__(cmd='bwa', **kwargs): 初始化类。

property algorithm

用于构建 BWT 索引的算法。

可用选项为

is：用于构建后缀数组的 IS 线性时间算法。它需要 5.37N 内存，其中 N 是数据库的大小。IS 速度适中，但不能处理大于 2GB 的数据库。IS 是默认算法，因为它很简单。

bwtsw：在 BWT-SW 中实现的算法。此方法适用于整个人类基因组，但它不适用于小于 10MB 的数据库，并且通常比 IS 慢。

这控制 -a 参数及其关联值的添加。将此属性设置为所需的参数值。

property c

构建颜色空间索引。输入 fasta 应位于核苷酸空间中。

此属性控制 -c 开关的添加，将此属性视为一个布尔值。

property infile

输入文件名

这控制 infile 参数及其关联值的添加。将此属性设置为所需的参数值。

property prefix

输出数据库的前缀 [与 db 文件名相同]

这控制 -p 参数及其关联值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.BwaAlignCommandline(cmd='bwa', **kwargs)

基础：AbstractCommandline

Burrows Wheeler Aligner (BWA) aln 的命令行包装器。

运行 BWA 比对，等效于

$ bwa aln [...] <in.db.fasta> <in.query.fq> > <out.sai>

有关详细信息，请参见 http://bio-bwa.sourceforge.net/bwa.shtml。

示例

>>> from Bio.Sequencing.Applications import BwaAlignCommandline
>>> reference_genome = "/path/to/reference_genome.fasta"
>>> read_file = "/path/to/read_1.fq"
>>> output_sai_file = "/path/to/read_1.sai"
>>> align_cmd = BwaAlignCommandline(reference=reference_genome, read_file=read_file)
>>> print(align_cmd)
bwa aln /path/to/reference_genome.fasta /path/to/read_1.fq

您通常会使用 align_cmd(stdout=output_sai_file) 或通过 Python subprocess 模块运行命令行，如 Biopython 教程中所述。

__init__(cmd='bwa', **kwargs): 初始化类。

property B

从 5 端开始的条形码长度。当 INT 为正时，每个读的条形码将在映射之前被修剪，并将被写入 BC SAM 标签。对于双端读，来自两端的条形码将被串联起来。[0]

这控制 -B 参数及其关联值的添加。将此属性设置为所需的参数值。

property E

间隙扩展惩罚 [4]

这控制 -E 参数及其关联值的添加。将此属性设置为所需的参数值。

property I

输入采用 Illumina 1.3+ 读格式（质量等于 ASCII-64）。

此属性控制 -I 开关的添加，将此属性视为一个布尔值。

property M

错配惩罚。BWA 不会搜索得分低于 (bestScore-misMsc) 的次优命中。[3]

这控制 -M 参数及其关联值的添加。将此属性设置为所需的参数值。

property N

禁用迭代搜索。将找到所有不超过 maxDiff 个差异的命中。此模式比默认模式慢得多。

此属性控制 -N 开关的添加，将此属性视为一个布尔值。

property O

间隙打开惩罚 [11]

这控制 -O 参数及其关联值的添加。将此属性设置为所需的参数值。

property R

如果存在不超过 INT 个相同最佳命中，则继续进行次优比对。

此选项仅影响双端映射。提高此阈值有助于提高配对精度，但会降低速度，尤其是在短读 (~32bp) 的情况下。

这控制 -R 参数及其关联值的添加。将此属性设置为所需的参数值。

property b

指定输入读序列文件为 BAM 格式

此属性控制 -b 开关的添加，将此属性视为一个布尔值。

property b1

当 -b 指定时，仅使用读对中的第一个读进行映射（跳过单端读和第二个读）。

此属性控制 -b1 开关的添加，将此属性视为一个布尔值。

property b2

当 -b 指定时，仅使用读对中的第二个读进行映射。

此属性控制 -b2 开关的添加，将此属性视为一个布尔值。

property c

反转查询但不取补码，这是颜色空间中比对所必需的。

此属性控制 -c 开关的添加，将此属性视为一个布尔值。

property d

不允许在 INT bp 范围内向 3 端方向进行长删除 [16]

这控制 -d 参数及其关联值的添加。将此属性设置为所需的参数值。

property e

间隙扩展的最大数量，-1 表示 k 差模式（不允许长间隙）[-1]

这控制 -e 参数及其关联值的添加。将此属性设置为所需的参数值。

property i

禁止在 INT bp 内的末端出现插入或缺失 [5]

这控制着 -i 参数及其相关值的添加。将此属性设置为所需的参数值。

property k

种子中的最大编辑距离 [2]

这控制着 -k 参数及其相关值的添加。将此属性设置为所需的参数值。

property l

将第一个 INT 子序列作为种子。

如果 INT 大于查询序列，则将禁用种子。对于长读序列，此选项通常在 -k 2 时介于 25 到 35 之间。[inf]

这控制着 -l 参数及其相关值的添加。将此属性设置为所需的参数值。

property n

如果值为 INT，则为最大编辑距离，如果为 FLOAT，则为给定 2% 均匀碱基错误率的缺失比对的比例。在后一种情况下，将根据不同的读取长度自动选择最大编辑距离。[0.04]

这控制着 -n 参数及其相关值的添加。将此属性设置为所需的参数值。

property o

如果值为 INT，则为最大编辑距离，如果为 FLOAT，则为给定 2% 均匀碱基错误率的缺失比对的比例。在后一种情况下，将根据不同的读取长度自动选择最大编辑距离。[0.04]

这控制着 -o 参数及其相关值的添加。将此属性设置为所需的参数值。

property q

用于读取修剪的参数 [0]。

如果 q_l<INT，则 BWA 会将读取修剪到 argmax_x{sum_{i=x+1}^l(INT-q_i)}，其中 l 是原始读取长度。

这控制着 -q 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_file

读取文件名称

这控制着 read_file 参数及其相关值的添加。将此属性设置为所需的参数值。

property reference

参考文件名称

这控制着 reference 参数及其相关值的添加。将此属性设置为所需的参数值。

property t

线程数量（多线程模式） [1]

这控制着 -t 参数及其相关值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.BwaSamseCommandline(cmd='bwa', **kwargs)

基础：AbstractCommandline

Burrows Wheeler Aligner (BWA) samse 的命令行包装器。

在给定单端读取的情况下，生成 SAM 格式的比对。等同于

$ bwa samse [-n maxOcc] <in.db.fasta> <in.sai> <in.fq> > <out.sam>

有关详细信息，请参见 http://bio-bwa.sourceforge.net/bwa.shtml。

示例

>>> from Bio.Sequencing.Applications import BwaSamseCommandline
>>> reference_genome = "/path/to/reference_genome.fasta"
>>> read_file = "/path/to/read_1.fq"
>>> sai_file = "/path/to/read_1.sai"
>>> output_sam_file = "/path/to/read_1.sam"
>>> samse_cmd = BwaSamseCommandline(reference=reference_genome,
...                                 read_file=read_file, sai_file=sai_file)
>>> print(samse_cmd)
bwa samse /path/to/reference_genome.fasta /path/to/read_1.sai /path/to/read_1.fq

您通常会使用 samse_cmd(stdout=output_sam_file) 或通过 Python 子进程模块运行命令行，如 Biopython 教程中所述。

__init__(cmd='bwa', **kwargs): 初始化类。

property n

对正确配对的读取在 XA 标签中输出的最大比对数量。

如果读取的命中次数超过 INT，则不会写入 XA 标签。[3]

这控制着 -n 参数及其相关值的添加。将此属性设置为所需的参数值。

property r

以 ‘@RG ID:foo SM:bar’ 这样的格式指定读取组。[null]

这控制着 -r 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_file

读取文件名称

这控制着 read_file 参数及其相关值的添加。将此属性设置为所需的参数值。

property reference

参考文件名称

这控制着 reference 参数及其相关值的添加。将此属性设置为所需的参数值。

property sai_file

Sai 文件名称

这控制着 sai_file 参数及其相关值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.BwaSampeCommandline(cmd='bwa', **kwargs)

基础：AbstractCommandline

Burrows Wheeler Aligner (BWA) sampe 的命令行包装器。

在给定双端读取的情况下，生成 SAM 格式的比对。等同于

$ bwa sampe [...] <in.db.fasta> <in1.sai> <in2.sai> <in1.fq> <in2.fq> > <out.sam>

有关详细信息，请参见 http://bio-bwa.sourceforge.net/bwa.shtml。

示例

>>> from Bio.Sequencing.Applications import BwaSampeCommandline
>>> reference_genome = "/path/to/reference_genome.fasta"
>>> read_file1 = "/path/to/read_1.fq"
>>> read_file2 = "/path/to/read_2.fq"
>>> sai_file1 = "/path/to/read_1.sai"
>>> sai_file2 = "/path/to/read_2.sai"
>>> output_sam_file = "/path/to/output.sam"
>>> read_group = r"@RG\tID:foo\tSM:bar"  # BWA will turn backslash-t into tab
>>> sampe_cmd = BwaSampeCommandline(reference=reference_genome,
...                                 sai_file1=sai_file1, sai_file2=sai_file2,
...                                 read_file1=read_file1, read_file2=read_file2,
...                                 r=read_group)
>>> print(sampe_cmd)
bwa sampe /path/to/reference_genome.fasta /path/to/read_1.sai /path/to/read_2.sai /path/to/read_1.fq /path/to/read_2.fq -r @RG\tID:foo\tSM:bar

您通常会使用 sampe_cmd(stdout=output_sam_file) 或通过 Python 子进程模块运行命令行，如 Biopython 教程中所述。

__init__(cmd='bwa', **kwargs): 初始化类。

property N

对不一致的读取对（不包括单读）在 XA 标签中输出的最大比对数量 [10]。

如果读取的命中次数超过 INT，则不会写入 XA 标签。

这控制着 -N 参数及其相关值的添加。将此属性设置为所需的参数值。

property a

要被视为正确映射的读取对的最大插入大小 [500]。

从 0.4.5 版本开始，此选项仅在没有足够的良好比对来推断插入大小分布时使用。

这控制 -a 参数及其关联值的添加。将此属性设置为所需的参数值。

property n

对正确配对的读取在 XA 标签中输出的最大比对数量 [3]。

如果读取的命中次数超过 INT，则不会写入 XA 标签。

这控制着 -n 参数及其相关值的添加。将此属性设置为所需的参数值。

property o

读取用于配对的最大出现次数 [100000]。

出现次数超过此值的读取将被视为单端读取。减少此参数有助于更快地配对。

这控制着 -o 参数及其相关值的添加。将此属性设置为所需的参数值。

property r

以 ‘@RG ID:foo SM:bar’ 这样的格式指定读取组。[null]

这控制着 -r 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_file1

读取文件 1

这控制着 read_file1 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_file2

读取文件 2

这控制着 read_file2 参数及其相关值的添加。将此属性设置为所需的参数值。

property reference

参考文件名称

这控制着 reference 参数及其相关值的添加。将此属性设置为所需的参数值。

property sai_file1

Sai 文件 1

这控制着 sai_file1 参数及其相关值的添加。将此属性设置为所需的参数值。

property sai_file2

Sai 文件 2

这控制着 sai_file2 参数及其相关值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.BwaBwaswCommandline(cmd='bwa', **kwargs)

基础：AbstractCommandline

Burrows Wheeler Aligner (BWA) bwasw 的命令行包装器。

对来自 FASTQ 文件的查询序列进行比对。等同于

$ bwa bwasw [...] <in.db.fasta> <in.fq>

有关详细信息，请参见 http://bio-bwa.sourceforge.net/bwa.shtml。

示例

>>> from Bio.Sequencing.Applications import BwaBwaswCommandline
>>> reference_genome = "/path/to/reference_genome.fasta"
>>> read_file = "/path/to/read_1.fq"
>>> bwasw_cmd = BwaBwaswCommandline(reference=reference_genome, read_file=read_file)
>>> print(bwasw_cmd)
bwa bwasw /path/to/reference_genome.fasta /path/to/read_1.fq

您通常会使用 bwasw_cmd() 或通过 Python 子进程模块运行命令行，如 Biopython 教程中所述。

__init__(cmd='bwa', **kwargs): 初始化类。

property N

支持结果比对的最小种子数，以跳过反向比对。 [5]

这控制着 -N 参数及其相关值的添加。将此属性设置为所需的参数值。

property T

最小分数阈值除以 [37]

这控制着 -T 参数及其关联值的添加。将此属性设置为所需的参数值。

property a

匹配分数 [1]

这控制 -a 参数及其关联值的添加。将此属性设置为所需的参数值。

property b

错配惩罚 [3]

这控制着 -b 参数及其关联值的添加。将此属性设置为所需的参数值。

property c

根据查询长度调整阈值的系数 [5.5]。

给定一个长度为 l 的查询，保留命中所需的阈值为 a*max{T,c*log(l)}。

这控制着 -c 参数及其关联值的添加。将此属性设置为所需的参数值。

property mate_file

配对文件

这控制着 mate_file 参数及其关联值的添加。将此属性设置为所需的参数值。

property q

间隙打开惩罚 [5]

这控制着 -q 参数及其相关值的添加。将此属性设置为所需的参数值。

property r

间隙扩展惩罚。大小为 k 的连续间隙的惩罚为 q+k*r。 [2]

这控制着 -r 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_file

读取文件

这控制着 read_file 参数及其相关值的添加。将此属性设置为所需的参数值。

property reference

参考文件名称

这控制着 reference 参数及其相关值的添加。将此属性设置为所需的参数值。

property s

用于启动种子的最大 SA 间隔大小 [3]。

更高的 -s 会以速度为代价提高准确性。

这控制着 -s 参数及其关联值的添加。将此属性设置为所需的参数值。

property t

多线程模式下的线程数 [1]

这控制着 -t 参数及其相关值的添加。将此属性设置为所需的参数值。

property w

带状比对中的带宽 [33]

这控制着 -w 参数及其关联值的添加。将此属性设置为所需的参数值。

property z

Z-best 启发式。更高的 -z 会以速度为代价提高准确性。 [1]

这控制着 -z 参数及其关联值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.BwaMemCommandline(cmd='bwa', **kwargs)

基础：AbstractCommandline

Burrows Wheeler Aligner (BWA) mem 的命令行包装器。

运行 BWA-MEM 比对，使用单端或双端读取，等效于

$ bwa mem [...] <in.db.fasta> <in1.fq> <in2.fq> > <out.sam>

有关详细信息，请参见 http://bio-bwa.sourceforge.net/bwa.shtml。

示例

>>> from Bio.Sequencing.Applications import BwaMemCommandline
>>> reference_genome = "/path/to/reference_genome.fasta"
>>> read_file = "/path/to/read_1.fq"
>>> output_sam_file = "/path/to/output.sam"
>>> align_cmd = BwaMemCommandline(reference=reference_genome, read_file1=read_file)
>>> print(align_cmd)
bwa mem /path/to/reference_genome.fasta /path/to/read_1.fq

您通常使用 align_cmd(stdout=output_sam_file) 或通过 Python 子进程模块运行命令行，如 Biopython 教程中所述。

__init__(cmd='bwa', **kwargs): 初始化类。

property A

匹配分数。 [1]

这控制着 -A 参数及其关联值的添加。将此属性设置为所需的参数值。

property B

错配惩罚。序列错误率约为：{.75 * exp[-log(4) * B/A]}。 [4]

这控制 -B 参数及其关联值的添加。将此属性设置为所需的参数值。

property C

将 FASTA/Q 注释追加到 SAM 输出。此选项可用于将读取元信息（例如条形码）传输到 SAM 输出。请注意，FASTA/Q 注释（标题行中空格后的字符串）必须符合 SAM 规范（例如 BC:Z:CGTAC）。格式错误的注释会导致 SAM 输出不正确。

此属性控制 -C 开关的添加，将此属性视为布尔值。

property E

间隙扩展惩罚。长度为 k 的间隙的成本为 O + k*E（即 -O 用于打开零长度间隙）。 [1]

这控制 -E 参数及其关联值的添加。将此属性设置为所需的参数值。

property H

在 SAM 输出中使用硬剪切“H”。此选项可以显著减少映射长重叠群或 BAC 序列时输出的冗余。

此属性控制 -H 开关的添加，将此属性视为布尔值。

property L

剪切惩罚。在执行 SW 扩展时，BWA-MEM 会跟踪到达查询末尾的最佳分数。如果此分数大于最佳 SW 分数减去剪切惩罚，则不会应用剪切。请注意，在这种情况下，SAM AS 标签报告最佳 SW 分数；不会扣除剪切惩罚。 [5]

这控制着 -L 参数及其关联值的添加。将此属性设置为所需的参数值。

property M

将较短的拆分命中标记为辅助（以实现 Picard 兼容性）。

此属性控制 -M 开关的添加，将此属性视为布尔值。

property O

间隙打开惩罚。 [6]

这控制 -O 参数及其关联值的添加。将此属性设置为所需的参数值。

property P

在双端模式下，仅执行 SW 以拯救丢失的命中，但不尝试查找适合正确配对的命中。

此属性控制 -P 开关的添加，将此属性视为布尔值。

property R

完整的读取组标题行。“t”可以在 STR 中使用，并将被转换为输出 SAM 中的 TAB。读取组 ID 将附加到输出中的每个读取。一个示例是 ‘@RG ID:foo SM:bar’。 [null]

这控制 -R 参数及其关联值的添加。将此属性设置为所需的参数值。

property T

不要输出分数低于 INT 的比对。此选项仅影响输出。 [30]

这控制着 -T 参数及其关联值的添加。将此属性设置为所需的参数值。

property U

未配对读取对的惩罚。BWA-MEM 将未配对读取对的分数计算为 scoreRead1+scoreRead2-INT，并将配对读取对的分数计算为 scoreRead1+scoreRead2-insertPenalty。它比较这两个分数以确定是否应该强制配对。 [9]

这控制着 -U 参数及其关联值的添加。将此属性设置为所需的参数值。

property a

输出单端或未配对双端读取的所有找到的比对。这些比对将被标记为辅助比对。

此属性控制 -a 开关的添加，将此属性视为布尔值。

property c

如果 MEM 在基因组中出现超过 INT 次，则将其丢弃。这是一个不敏感的参数。 [10000]

这控制着 -c 参数及其关联值的添加。将此属性设置为所需的参数值。

property d

非对角线 X-dropoff（Z-dropoff）。当最佳扩展分数与当前扩展分数之间的差值大于 |i-j|*A+INT 时停止扩展，其中 i 和 j 分别是查询和参考的当前位置，A 是匹配分数。Z-dropoff 类似于 BLAST 的 X-dropoff，只是它不会对比对中其中一个序列的间隙进行惩罚。Z-dropoff 不仅可以避免不必要的扩展，还可以减少长良性比对内部的劣质比对。 [100]

这控制 -d 参数及其关联值的添加。将此属性设置为所需的参数值。

property k

最小种子长度。长度小于 INT 的匹配将被忽略。比对速度通常对该值不敏感，除非它显著偏离 20。 [19]

这控制着 -k 参数及其相关值的添加。将此属性设置为所需的参数值。

property p

假设第一个输入查询文件是交错的双端 FASTA/Q。有关详细信息，请参见命令描述。

此属性控制 -p 开关的添加，将此属性视为布尔值。

property r

为长度大于 minSeedLen*FLOAT 的 MEM 触发重新播种。这是用于调整性能的关键启发式参数。较大的值会产生较少的种子，这会导致更快的比对速度，但准确性较低。[1.5]

这控制着 -r 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_file1

读取 1 文件名

这控制着 read_file1 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_file2

读取 2 文件名

这控制着 read_file2 参数及其相关值的添加。将此属性设置为所需的参数值。

property reference

参考文件名称

这控制着 reference 参数及其相关值的添加。将此属性设置为所需的参数值。

property t

线程数 [1]

这控制着 -t 参数及其相关值的添加。将此属性设置为所需的参数值。

property v

控制输出的详细级别。此选项尚未在整个 BWA 中得到完全支持。理想情况下，值为 0 表示禁用所有输出到 stderr；1 表示仅输出错误；2 表示警告和错误；3 表示所有正常消息；4 或更高表示调试。当此选项取值 4 时，输出不是 SAM。[3]

这控制 -v 参数及其关联值的添加。将此属性设置为所需的参数值。

property w

带宽。本质上，长度大于 INT 的间隙将不会被找到。请注意，最大间隙长度还受评分矩阵和命中长度的影响，并非完全由此选项确定。[100]

这控制着 -w 参数及其关联值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.NovoalignCommandline(cmd='novoalign', **kwargs)

基础：AbstractCommandline

Novocraft 的 novoalign 命令行包装器。

请参见 www.novocraft.com - novoalign 是一种短读比对程序。

示例

>>> from Bio.Sequencing.Applications import NovoalignCommandline
>>> novoalign_cline = NovoalignCommandline(database='some_db',
...                                        readfile='some_seq.txt')
>>> print(novoalign_cline)
novoalign -d some_db -f some_seq.txt

与所有 Biopython 应用程序包装器一样，您也可以在创建对象后添加或更改选项。

>>> novoalign_cline.format = 'PRBnSEQ'
>>> novoalign_cline.r_method='0.99' # limited valid values
>>> novoalign_cline.fragment = '250 20' # must be given as a string
>>> novoalign_cline.miRNA = 100
>>> print(novoalign_cline)
novoalign -d some_db -f some_seq.txt -F PRBnSEQ -r 0.99 -i 250 20 -m 100

您通常会使用 novoalign_cline() 或通过 Python 子进程模块运行命令行，如 Biopython 教程中所述。

最后检查版本：2.05.04

__init__(cmd='novoalign', **kwargs): 初始化类。

property adapter3

在比对之前剥离 3' 适配器序列。

对于配对末端，可以指定两个适配器。

这控制 -a 参数及其关联值的添加。将此属性设置为所需的参数值。

property adapter5

剥离 5' 适配器序列。

类似于 -a (adaptor3)，但在 5' 端。

这控制 -5 参数及其关联值的添加。将此属性设置为所需的参数值。

property cores

线程数，在免费版本中禁用 [默认：核心数]

这控制着 -c 参数及其关联值的添加。将此属性设置为所需的参数值。

property database

数据库文件名

这控制 -d 参数及其关联值的添加。将此属性设置为所需的参数值。

property format

读取文件的格式。

允许的值：FA、SLXFQ、STDFQ、ILMFQ、PRB、PRBnSEQ

这控制 -F 参数及其关联值的添加。将此属性设置为所需的参数值。

property fragment

片段长度（2 个读数 + 插入）和标准偏差 [默认：250 30]

这控制着 -i 参数及其相关值的添加。将此属性设置为所需的参数值。

property gap_extend

间隙扩展惩罚 [默认：15]

这控制 -x 参数及其关联值的添加。将此属性设置为所需的参数值。

property gap_open

间隙打开惩罚 [默认：40]

这控制 -g 参数及其关联值的添加。将此属性设置为所需的参数值。

property good_bases

良好质量碱基的最小数量 [默认：log(N_g, 4) + 5]

这控制着 -l 参数及其相关值的添加。将此属性设置为所需的参数值。

property homopolymer

同聚物读取过滤器 [默认：20；禁用：负值]

这控制 -h 参数及其关联值的添加。将此属性设置为所需的参数值。

property miRNA

设置 miRNA 模式并可选地为扫描的区域设置一个值 [默认：关闭]

这控制 -m 参数及其关联值的添加。将此属性设置为所需的参数值。

property qual_digits

质量得分的十进制位数 [默认：0]

这控制着 -q 参数及其相关值的添加。将此属性设置为所需的参数值。

property quality

报告比对的较低阈值 [默认：0]

这控制 -Q 参数及其关联值的添加。将此属性设置为所需的参数值。

property r_method

报告具有多个匹配的读数的方法。

允许的值：None、Random、All、Exhaustive、0.99 'All' 和 'Exhaustive' 接受限制。

这控制着 -r 参数及其相关值的添加。将此属性设置为所需的参数值。

property read_cal

从文件读取质量校准（不匹配计数）

这控制着 -k 参数及其相关值的添加。将此属性设置为所需的参数值。

property readfile

读取文件

这控制 -f 参数及其关联值的添加。将此属性设置为所需的参数值。

property recorded

比对记录的分数等于最佳分数。

默认：在默认读取方法中为 1000，否则没有限制。

这控制 -e 参数及其关联值的添加。将此属性设置为所需的参数值。

property repeats

如果分数差异更高，则报告重复。

否则，-r 读取方法适用 [默认：5]

这控制 -R 参数及其关联值的添加。将此属性设置为所需的参数值。

property report

指定报告格式。

允许的值：Native、Pairwise、SAM 默认：Native

这控制着 -o 参数及其相关值的添加。将此属性设置为所需的参数值。

property threshold

比对分数的阈值

这控制着 -t 参数及其相关值的添加。将此属性设置为所需的参数值。

property trimming

如果无法比对，则按 s 个碱基修剪，直到它们映射或变得短于 l。

Ddefault：2

这控制着 -s 参数及其关联值的添加。将此属性设置为所需的参数值。

property truncate

在比对之前截断到特定长度

这控制着 -n 参数及其相关值的添加。将此属性设置为所需的参数值。

property unconverted

实验性：亚硫酸氢盐模式下未转换的胞嘧啶惩罚

默认：无惩罚

这控制 -u 参数及其关联值的添加。将此属性设置为所需的参数值。

property variation

结构变异惩罚 [默认：70]

这控制 -v 参数及其关联值的添加。将此属性设置为所需的参数值。

property write_cal

累积不匹配计数并写入文件

这控制 -K 参数及其关联值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsViewCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools view 命令行包装器。

提取/打印 SAM 或 BAM 格式中的所有或子比对，等效于

$ samtools view [-bchuHS] [-t in.refList] [-o output] [-f reqFlag]
                [-F skipFlag] [-q minMapQ] [-l library] [-r readGroup]
                [-R rgFile] <in.bam>|<in.sam> [region1 [...]]

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsViewCommandline
>>> input_file = "/path/to/sam_or_bam_file"
>>> samtools_view_cmd = SamtoolsViewCommandline(input_file=input_file)
>>> print(samtools_view_cmd)
samtools view /path/to/sam_or_bam_file

__init__(cmd='samtools', **kwargs): 初始化类。

property F

跳过在 INT 中存在位的比对

这控制 -F 参数及其关联值的添加。将此属性设置为所需的参数值。

property H

仅输出标题

此属性控制 -H 开关的添加，将此属性视为布尔值。

property R

在 FILE 中列出的读取组中输出读取

这控制 -R 参数及其关联值的添加。将此属性设置为所需的参数值。

property S

输入为 SAM。: 如果不存在 @SQ 标头行，则需要 “-t” 选项。

此属性控制添加 -S 开关，将此属性视为布尔值。

property b

以 BAM 格式输出

此属性控制 -b 开关的添加，将此属性视为一个布尔值。

property c

不打印比对，只统计它们并

打印总数。

所有过滤器选项，例如 “-f”、“-F” 和 “-q”，都会被考虑在内

此属性控制 -c 开关的添加，将此属性视为一个布尔值。

property f

仅输出在: INT 中存在所有位的比对

这控制 -f 参数及其关联值的添加。将此属性设置为所需的参数值。

property fast_bam

使用 zlib 压缩级别 1 来压缩输出

此属性控制添加 -1 开关，将此属性视为布尔值。

property h

在输出中包含标题

此属性控制添加 -h 开关，将此属性视为布尔值。

property input_file

输入文件名

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

property l

仅输出库 STR 中的读取

这控制着 -l 参数及其相关值的添加。将此属性设置为所需的参数值。

property o

输出文件

这控制着 -o 参数及其相关值的添加。将此属性设置为所需的参数值。

property q

跳过 MAPQ 小于 INT 的比对

这控制着 -q 参数及其相关值的添加。将此属性设置为所需的参数值。

property r

仅输出读取组 STR 中的读取

这控制着 -r 参数及其相关值的添加。将此属性设置为所需的参数值。

property region

区域

这控制添加区域参数及其关联的值。将此属性设置为所需的参数值。

property t

此文件以 TAB 分隔。

每行必须包含参考名称和参考长度，每条不同的参考一行；其他字段将被忽略。

此文件还定义了参考序列在排序中的顺序。如果您运行 “samtools faidx <ref.fa>”，“<ref.fa>.fai” 结果索引文件可以用作此 “<in.ref_list>” 文件。

这控制着 -t 参数及其相关值的添加。将此属性设置为所需的参数值。

property u

输出未压缩的 BAM。

此选项节省了用于压缩/解压缩的时间，因此当输出被管道传输到另一个 samtools 命令时，它更可取

此属性控制添加 -u 开关，将此属性视为布尔值。

class Bio.Sequencing.Applications.SamtoolsCalmdCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools calmd 命令行包装器。

生成 MD 标签，等效于

$ samtools calmd [-EeubSr] [-C capQcoef] <aln.bam> <ref.fasta>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsCalmdCommandline
>>> input_bam = "/path/to/aln.bam"
>>> reference_fasta = "/path/to/reference.fasta"
>>> calmd_cmd = SamtoolsCalmdCommandline(input_bam=input_bam,
...                                      reference=reference_fasta)
>>> print(calmd_cmd)
samtools calmd /path/to/aln.bam /path/to/reference.fasta

__init__(cmd='samtools', **kwargs): 初始化类。

property A

当与 -r 一起使用时，此选项会覆盖: 原始碱基质量

此属性控制添加 -A 开关，将此属性视为布尔值。

property C

用于限制映射质量的系数

映射不良的读取。

有关详细信息，请参阅 pileup 命令。

这控制添加 -C 参数及其关联的值。将此属性设置为所需的参数值。

property E

扩展的 BAQ 计算。: 此选项将特异性换取敏感性，尽管效果很小。

此属性控制添加 -E 开关，将此属性视为布尔值。

property S

输入是带有标头行的 SAM

此属性控制添加 -S 开关，将此属性视为布尔值。

property b

输出压缩的 BAM

此属性控制 -b 开关的添加，将此属性视为一个布尔值。

property e

如果读取碱基

与比对的参考碱基相同，则将其转换为 =。

Indel 调用器目前不支持 = 碱基。

此属性控制添加 -e 开关，将此属性视为布尔值。

property input_bam

输入 BAM

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

property r

计算 BQ 标签（不带 -A）: 或通过 BAQ 限制碱基质量（带 -A）。

此属性控制添加 -r 开关，将此属性视为布尔值。

property ref

要索引的参考 FASTA

这控制着 reference 参数及其相关值的添加。将此属性设置为所需的参数值。

property u

输出未压缩的 BAM

此属性控制添加 -u 开关，将此属性视为布尔值。

class Bio.Sequencing.Applications.SamtoolsCatCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools cat 命令行包装器。

连接 BAM，等效于

$ samtools cat [-h header.sam] [-o out.bam] <in1.bam> <in2.bam> [ ... ]

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsCatCommandline
>>> input_bam1 = "/path/to/input_bam1"
>>> input_bam2 = "/path/to/input_bam2"
>>> input_bams = [input_bam1, input_bam2]
>>> samtools_cat_cmd = SamtoolsCatCommandline(input_bam=input_bams)
>>> print(samtools_cat_cmd)
samtools cat /path/to/input_bam1 /path/to/input_bam2

__init__(cmd='samtools', **kwargs): 初始化类。

property bams

输入 BAM 文件

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

property h

头文件 SAM 文件

这控制 -h 参数及其关联值的添加。将此属性设置为所需的参数值。

property o

输出 SAM 文件

这控制着 -o 参数及其相关值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsFaidxCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools faidx 命令行包装器。

检索并打印索引文件中的统计信息，等效于

$ samtools faidx <ref.fasta> [region1 [...]]

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsFaidxCommandline
>>> reference = "/path/to/reference.fasta"
>>> samtools_faidx_cmd = SamtoolsFaidxCommandline(reference=reference)
>>> print(samtools_faidx_cmd)
samtools faidx /path/to/reference.fasta

__init__(cmd='samtools', **kwargs): 初始化类。

property ref

要索引的参考 FASTA

这控制着 reference 参数及其相关值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsFixmateCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools fixmate 命令行包装器。

从名称排序的对齐中填充配对坐标、ISIZE 和配对相关标志，等效于

$ samtools fixmate <in.nameSrt.bam> <out.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsFixmateCommandline
>>> in_bam = "/path/to/in.nameSrt.bam"
>>> out_bam = "/path/to/out.bam"
>>> fixmate_cmd = SamtoolsFixmateCommandline(input_bam=in_bam,
...                                          out_bam=out_bam)
>>> print(fixmate_cmd)
samtools fixmate /path/to/in.nameSrt.bam /path/to/out.bam

__init__(cmd='samtools', **kwargs): 初始化类。

property input_file

名称排序的对齐文件

这控制着 in_bam 参数及其关联值的添加。将此属性设置为所需的参数值。

property output_file

输出文件

这控制着 out_bam 参数及其关联值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsIdxstatsCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools idxstats 命令行包装器。

检索并打印索引文件中的统计信息，等效于

$ samtools idxstats <aln.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsIdxstatsCommandline
>>> input = "/path/to/aln_bam"
>>> samtools_idxstats_cmd = SamtoolsIdxstatsCommandline(input_bam=input)
>>> print(samtools_idxstats_cmd)
samtools idxstats /path/to/aln_bam

__init__(cmd='samtools', **kwargs): 初始化类。

property input_bam

要索引的 BAM 文件

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsIndexCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools index 命令行包装器。

索引排序后的对齐以实现快速随机访问，等效于

$ samtools index <aln.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsIndexCommandline
>>> input = "/path/to/aln_bam"
>>> samtools_index_cmd = SamtoolsIndexCommandline(input_bam=input)
>>> print(samtools_index_cmd)
samtools index /path/to/aln_bam

__init__(cmd='samtools', **kwargs): 初始化类。

property input_bam

要索引的 BAM 文件

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsMergeCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools merge 命令行包装器。

合并多个排序后的对齐，等效于

$ samtools merge [-nur1f] [-h inh.sam] [-R reg]
                 <out.bam> <in1.bam> <in2.bam> [...]

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsMergeCommandline
>>> out_bam = "/path/to/out_bam"
>>> in_bam = ["/path/to/input_bam1", "/path/to/input_bam2"]
>>> merge_cmd = SamtoolsMergeCommandline(out_bam=out_bam,
...                                      input_bam=in_bam)
>>> print(merge_cmd)
samtools merge /path/to/out_bam /path/to/input_bam1 /path/to/input_bam2

__init__(cmd='samtools', **kwargs): 初始化类。

property R

合并 STR 指示的指定区域中的文件

这控制 -R 参数及其关联值的添加。将此属性设置为所需的参数值。

property bam

输入 BAM

这控制着 input_bam 参数及其关联值的添加。将此属性设置为所需的参数值。

property f

强制覆盖: 如果存在输出文件

此属性控制着 -f 开关的添加，将此属性视为一个布尔值。

property fast_bam

使用 zlib 压缩级别 1: 压缩输出

此属性控制添加 -1 开关，将此属性视为布尔值。

property h

使用 FILE 中的行作为“@”: 头文件将被复制到 out.bam

这控制 -h 参数及其关联值的添加。将此属性设置为所需的参数值。

property n

输入对齐按读取名称排序: 而不是按染色体坐标排序

此属性控制着 -n 开关的添加，将此属性视为一个布尔值。

property output

输出 BAM 文件

这控制着 output_bam 参数及其关联值的添加。将此属性设置为所需的参数值。

property r

将 RG 标签附加到每个对齐。: 标签值从文件名推断

此属性控制添加 -r 开关，将此属性视为布尔值。

property u

未压缩的 BAM 输出

此属性控制添加 -u 开关，将此属性视为布尔值。

class Bio.Sequencing.Applications.SamtoolsMpileupCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools mpileup 命令行包装器。

为一个或多个 BAM 文件生成 BCF 或 pileup，等效于

$ samtools mpileup [-EBug] [-C capQcoef] [-r reg] [-f in.fa]
                   [-l list] [-M capMapQ] [-Q minBaseQ]
                   [-q minMapQ] in.bam [in2.bam [...]]

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsMpileupCommandline
>>> input = ["/path/to/sam_or_bam_file"]
>>> samtools_mpileup_cmd = SamtoolsMpileupCommandline(input_file=input)
>>> print(samtools_mpileup_cmd)
samtools mpileup /path/to/sam_or_bam_file

__init__(cmd='samtools', **kwargs): 初始化类。

property A

在变异调用中不跳过异常读取对。

此属性控制添加 -A 开关，将此属性视为布尔值。

property B

禁用对

碱基比对质量 (BAQ) 计算的概率重新比对。

BAQ 是读取碱基被错误比对的 Phred 比例概率。应用此选项极大地有助于减少由错误比对引起的假 SNP

此属性控制着 -B 开关的添加，将此属性视为一个布尔值。

property C

用于降低映射质量的系数

包含过多错配的reads。

给定一个read，其从映射位置生成的phred-scaled概率为q，则新的映射质量约为sqrt((INT-q)/INT)*INT。零值将禁用此功能；如果启用，BWA的推荐值为50。

这控制添加 -C 参数及其关联的值。将此属性设置为所需的参数值。

property D

输出每个样本的read深度。

此属性控制-D开关的添加，将此属性视为布尔值。

property E

扩展BAQ计算。: 此选项有助于提高敏感性，特别是对于MNP，但可能会稍微降低特异性。

此属性控制添加 -E 开关，将此属性视为布尔值。

property I

不执行INDEL调用。

此属性控制 -I 开关的添加，将此属性视为一个布尔值。

property L

如果平均每个样本: 深度高于INT，则跳过INDEL调用。

这控制着 -L 参数及其关联值的添加。将此属性设置为所需的参数值。

property M

将映射质量限制为M。

这控制 -M 参数及其关联值的添加。将此属性设置为所需的参数值。

property Q

要考虑的碱基的最小碱基质量。

这控制 -Q 参数及其关联值的添加。将此属性设置为所需的参数值。

property S

输出每个样本的Phred-scaled: 链偏差P值。

此属性控制添加 -S 开关，将此属性视为布尔值。

property b

输入BAM文件列表，每行一个文件。

这控制着 -b 参数及其关联值的添加。将此属性设置为所需的参数值。

property d

在某个位置，每个输入BAM最多读取INT个reads。

这控制 -d 参数及其关联值的添加。将此属性设置为所需的参数值。

property e

Phred-scaled间隙扩展测序错误概率。

降低INT会导致更长的indels。

这控制 -e 参数及其关联值的添加。将此属性设置为所需的参数值。

property f

FASTA格式的faidx-indexed参考文件。

该文件可以选择通过razip压缩。

这控制 -f 参数及其关联值的添加。将此属性设置为所需的参数值。

property g

计算基因型可能性并以: 二进制调用格式（BCF）输出。

此属性控制-g开关的添加，将此属性视为布尔值。

property h

用于建模同聚物错误的系数。

给定一个长度为l的同聚物运行，大小为s的indel的测序错误被建模为INT*s/l。

这控制 -h 参数及其关联值的添加。将此属性设置为所需的参数值。

property illumina_13

假设质量采用Illumina 1.3+编码。

此属性控制-6开关的添加，将此属性视为布尔值。

property input_file

生成mpileup的输入文件。

这控制着input_file参数及其关联值的添加。将此属性设置为所需的参数值。

property l

包含区域列表的BED或位置列表文件: 或应生成pileup或BCF的站点。

这控制着 -l 参数及其相关值的添加。将此属性设置为所需的参数值。

property o

Phred-scaled间隙打开测序错误概率。

降低INT会导致更多的indel调用。

这控制着 -o 参数及其相关值的添加。将此属性设置为所需的参数值。

property p

从哪些平台（由@RG-PL确定）获得indel候选者

的逗号分隔列表。

建议从具有低indel错误率的测序技术（如ILLUMINA）中收集indel候选者。

这控制 -p 参数及其关联值的添加。将此属性设置为所需的参数值。

property q

要使用的比对的最小映射质量。

这控制着 -q 参数及其相关值的添加。将此属性设置为所需的参数值。

property r

仅在区域STR中生成pileup。

这控制着 -r 参数及其相关值的添加。将此属性设置为所需的参数值。

property u

与-g类似，只是输出: 是未压缩的BCF，这更适合于管道处理。

此属性控制添加 -u 开关，将此属性视为布尔值。

class Bio.Sequencing.Applications.SamtoolsPhaseCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools phase的命令行包装器。

调用和分期杂合SNP，等效于

$ samtools phase [-AF] [-k len] [-b prefix]
                 [-q minLOD] [-Q minBaseQ] <in.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsPhaseCommandline
>>> input_bam = "/path/to/in.bam"
>>> samtools_phase_cmd = SamtoolsPhaseCommandline(input_bam=input_bam)
>>> print(samtools_phase_cmd)
samtools phase /path/to/in.bam

__init__(cmd='samtools', **kwargs): 初始化类。

property A

丢弃具有模糊分期的reads。

此属性控制添加 -A 开关，将此属性视为布尔值。

property F

不尝试修复嵌合reads。

此属性控制-F开关的添加，将此属性视为布尔值。

property Q

用于het调用的最小碱基质量。: 用于het调用。

这控制 -Q 参数及其关联值的添加。将此属性设置为所需的参数值。

property b

BAM输出的前缀。

这控制着 -b 参数及其关联值的添加。将此属性设置为所需的参数值。

property in_bam

输入文件。

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

property k

局部分期的最大长度。

这控制着 -k 参数及其相关值的添加。将此属性设置为所需的参数值。

property q

调用杂合子的最小Phred-scaled LOD。: 调用杂合子。

这控制着 -q 参数及其相关值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsReheaderCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools reheader的命令行包装器。

将in.bam中的头替换为in.header.sam中的头，等效于

$ samtools reheader <in.header.sam> <in.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsReheaderCommandline
>>> input_header = "/path/to/header_sam_file"
>>> input_bam = "/path/to/input_bam_file"
>>> reheader_cmd = SamtoolsReheaderCommandline(input_header=input_header,
...                                            input_bam=input_bam)
>>> print(reheader_cmd)
samtools reheader /path/to/header_sam_file /path/to/input_bam_file

__init__(cmd='samtools', **kwargs): 初始化类。

property bam_file

用于写入头的BAM文件。

这控制着 input_bam 参数及其关联值的添加。将此属性设置为所需的参数值。

property sam_file

带有头的Sam文件。

这控制着input_header参数及其关联值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsRmdupCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools rmdup的命令行包装器。

移除潜在的PCR重复，等效于

$ samtools rmdup [-sS] <input.srt.bam> <out.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsRmdupCommandline
>>> input_sorted_bam = "/path/to/input.srt.bam"
>>> out_bam = "/path/to/out.bam"
>>> rmdup_cmd = SamtoolsRmdupCommandline(input_bam=input_sorted_bam,
...                                      out_bam=out_bam)
>>> print(rmdup_cmd)
samtools rmdup /path/to/input.srt.bam /path/to/out.bam

__init__(cmd='samtools', **kwargs): 初始化类。

property S

将双端测序reads: 视为单端reads

此属性控制添加 -S 开关，将此属性视为布尔值。

property input_file

名称排序的对齐文件

这控制着 in_bam 参数及其关联值的添加。将此属性设置为所需的参数值。

property output_file

输出文件

这控制着 out_bam 参数及其关联值的添加。将此属性设置为所需的参数值。

property s

移除单端reads的重复序列。

默认情况下，该命令仅适用于双端reads

此属性控制是否添加 -s 开关，将其视为布尔值。

Bio.Sequencing.Applications.SamtoolsSortCommandline: 别名 SamtoolsVersion0xSortCommandline

class Bio.Sequencing.Applications.SamtoolsVersion0xSortCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools 版本 0.1.x sort 的命令行包装器。

连接 BAM，等效于

$ samtools sort [-no] [-m maxMem] <in.bam> <out.prefix>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsVersion0xSortCommandline
>>> input_bam = "/path/to/input_bam"
>>> out_prefix = "/path/to/out_prefix"
>>> samtools_sort_cmd = SamtoolsVersion0xSortCommandline(input=input_bam, out_prefix=out_prefix)
>>> print(samtools_sort_cmd)
samtools sort /path/to/input_bam /path/to/out_prefix

__init__(cmd='samtools', **kwargs): 初始化类。

property input

输入 BAM 文件

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

property m

大约需要的最大内存

这控制 -m 参数及其关联值的添加。将此属性设置为所需的参数值。

property n

按reads名称排序，: 而不是按染色体坐标排序

此属性控制着 -n 开关的添加，将此属性视为一个布尔值。

property o

将最终比对: 输出到标准输出

此属性控制是否添加 -o 开关，将其视为布尔值。

property out_prefix

输出前缀

这控制是否添加 out_prefix 参数及其关联的值。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsVersion1xSortCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools 版本 1.3.x sort 的命令行包装器。

连接 BAM，等效于

$ samtools sort [-n] [-T FREFIX] [-o file] [-I INT] [-m maxMem] <in.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsVersion1xSortCommandline
>>> input_bam = "/path/to/input_bam"
>>> FREFIX = "/path/to/out_prefix"
>>> file_name = "/path/to/out_file"
>>> samtools_sort_cmd = SamtoolsVersion1xSortCommandline(input=input_bam, T=FREFIX, o=file_name)
>>> print(samtools_sort_cmd)
samtools sort -o /path/to/out_file -T /path/to/out_prefix /path/to/input_bam

__init__(cmd='samtools', **kwargs): 初始化类。

property I

(INT) 设置最终输出文件的压缩级别，: 范围从 0（未压缩）或 1（最快但压缩最少）到 9（最佳压缩但写入速度最慢），类似于 gzip(1) 的压缩级别设置。

这控制是否添加 -I 参数及其关联的值。将此属性设置为所需的参数值。

property O

(FORMAT) 将最终输出写入 sam、bam 或 cram

这控制 -O 参数及其关联值的添加。将此属性设置为所需的参数值。

property T

(PREFIX) 将临时文件写入 PREFIX.nnnn.bam，或者如果指定的 PREFIX: 是一个现有目录，则写入 PREFIX/samtools.mmm.mmm.tmp.nnnn.bam，其中 mmm 是对 sort 命令的此次调用的唯一标识

这控制着 -T 参数及其关联值的添加。将此属性设置为所需的参数值。

property input

输入 SAM/BAM/CRAM 文件

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。

property m

大约需要的最大内存

这控制 -m 参数及其关联值的添加。将此属性设置为所需的参数值。

property n

按reads名称排序，: 而不是按染色体坐标排序

此属性控制着 -n 开关的添加，将此属性视为一个布尔值。

property o

(file) 将最终排序后的输出写入 FILE，: 而不是写入标准输出

这控制着 -o 参数及其相关值的添加。将此属性设置为所需的参数值。

class Bio.Sequencing.Applications.SamtoolsTargetcutCommandline(cmd='samtools', **kwargs)

基础：AbstractCommandline

samtools targetcut 的命令行包装器。

该命令通过检查读深度的连续性来识别目标区域，计算目标的单倍体共有序列，并输出一个 SAM，其中每个序列对应于一个目标，等效于

$ samtools targetcut [-Q minBaseQ] [-i inPenalty] [-0 em0]
                     [-1 em1] [-2 em2] [-f ref] <in.bam>

有关更多详细信息，请参阅 http://samtools.sourceforge.net/samtools.shtml

示例

>>> from Bio.Sequencing.Applications import SamtoolsTargetcutCommandline
>>> input_bam = "/path/to/aln.bam"
>>> samtools_targetcut_cmd = SamtoolsTargetcutCommandline(input_bam=input_bam)
>>> print(samtools_targetcut_cmd)
samtools targetcut /path/to/aln.bam

__init__(cmd='samtools', **kwargs): 初始化类。

property Q

最低碱基质量

这控制 -Q 参数及其关联值的添加。将此属性设置为所需的参数值。

property em0: 这控制是否添加 -0 参数及其关联的值。将此属性设置为所需的参数值。

property em1: 这控制是否添加 -1 参数及其关联的值。将此属性设置为所需的参数值。

property em2: 这控制是否添加 -2 参数及其关联的值。将此属性设置为所需的参数值。

property f

参考文件名

这控制 -f 参数及其关联值的添加。将此属性设置为所需的参数值。

property i

插入惩罚

这控制着 -i 参数及其相关值的添加。将此属性设置为所需的参数值。

property in_bam

输入文件。

这控制添加输入参数及其关联的值。将此属性设置为所需的参数值。