Bio.Sequencing.Applications软件包¶
模块内容¶
对相关命令行应用程序包装进行排序(已过时)。
我们已经决定在将来删除此模块,建议您构建命令并直接通过子进程模块调用它。
- class Bio.Sequencing.Applications.BwaIndexCommandline(cmd='bwa', **kwargs)¶
-
Burows Wheeler对齐程序(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子进程模块运行该命令,如Biopython教程中所述。
- __init__(cmd='bwa', **kwargs)¶
初始化类。
- property algorithm¶
构建BWT索引的算法。
- 可用选项包括:
is:是构造后缀数组的线性时间算法。它需要5.37N内存,其中N是数据库的大小。IS速度中等,但不适用于大于2 GB的数据库。由于其简单性,IS是默认算法。
bwtsw:在BWT-SW中实现的算法。这种方法适用于整个人类基因组,但不适用于小于10MB的数据库,而且通常比现在慢。
这控制-a参数及其关联值的添加。将此属性设置为所需的参数值。
- property c¶
建立色彩空间索引。输入的FASTA应该在核苷酸空间内。
此属性控制-c开关的添加,将此属性视为布尔值。
- property infile¶
输入文件名
这将控制Infile参数及其关联值的添加。将此属性设置为所需的参数值。
- property prefix¶
输出数据库的前缀 [与数据库文件名相同]
这控制-p参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.BwaAlignCommandline(cmd='bwa', **kwargs)¶
-
Burows 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子进程模块运行命令行,如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不会搜索分数低于(Best Score-misMsc)的次优命中。 [3]
这控制-M参数及其关联值的添加。将此属性设置为所需的参数值。
- property N¶
禁用迭代搜索。将找到差异不超过maxDiff的所有命中。此模式比默认模式慢得多。
此属性控制-N开关的添加,将此属性视为布尔值。
- property O¶
空档罚球 [11]
这控制-O参数及其关联值的添加。将此属性设置为所需的参数值。
- property R¶
如果最多只有整数个相同的最佳匹配,则继续进行次优比对。
此选项仅影响成对端贴图。增加此阈值有助于提高配对准确性,但会以速度为代价,特别是对于短读取(~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¶
最大间隙扩展数,k-差模式为-1(不允许长间隙) [-1]
这控制-e参数及其关联值的添加。将此属性设置为所需的参数值。
- property i¶
不允许在INT BP内向两端插入 [5]
这控制-i参数及其关联值的添加。将此属性设置为所需的参数值。
- property k¶
种子中的最大编辑距离 [2]
这控制-k参数及其关联值的添加。将此属性设置为所需的参数值。
- property l¶
取第一个整型子序列作为种子。
如果int大于查询序列,将禁用种子设定。对于长时间读取,对于-k2,此选项的范围通常在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¶
引用文件名
这控制参考参数及其关联值的添加。将此属性设置为所需的参数值。
- property t¶
线程数(多线程模式) [1]
这控制-t参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.BwaSamseCommandline(cmd='bwa', **kwargs)¶
-
Burows 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¶
引用文件名
这控制参考参数及其关联值的添加。将此属性设置为所需的参数值。
- property sai_file¶
SAI文件名
这控制着sai_file参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.BwaSampeCommandline(cmd='bwa', **kwargs)¶
-
Burows 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¶
引用文件名
这控制参考参数及其关联值的添加。将此属性设置为所需的参数值。
- property sai_file1¶
SAI文件1
这控制sai_file1参数及其关联值的添加。将此属性设置为所需的参数值。
- property sai_file2¶
SAI文件2
这控制sai_file2参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.BwaBwaswCommandline(cmd='bwa', **kwargs)¶
-
Burows Wheeler Aligner(BWA)BWAW的命令行包装器。
对齐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-long查询,保留命中的阈值是 最大{{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¶
引用文件名
这控制参考参数及其关联值的添加。将此属性设置为所需的参数值。
- property s¶
启动种子的最大SA间隔大小 [3] 。
-s越高,精度越高,但以速度为代价。
这控制-s参数及其关联值的添加。将此属性设置为所需的参数值。
- property t¶
多线程模式下的线程数 [1]
这控制-t参数及其关联值的添加。将此属性设置为所需的参数值。
- property w¶
带状路线中的带区宽度 [33]
这控制-w参数及其关联值的添加。将此属性设置为所需的参数值。
- property z¶
Z-最佳启发式算法。z值越高,精度越高,但速度越低。 [1]
这控制-z参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.BwaMemCommandline(cmd='bwa', **kwargs)¶
-
Burows 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-insert。它将这两个分数进行比较,以确定我们是否应该强制配对。 [9]
这控制-U参数及其关联值的添加。将此属性设置为所需的参数值。
- property a¶
为单端或未配对的成对端读取输出所有找到的对齐。这些路线将标记为二次路线。
此属性控制-a开关的添加,将此属性视为布尔值。
- property c¶
如果一个MEM在基因组中出现多个int,则丢弃该MEM。这是一个不敏感的参数。 [10000]
这控制-c参数及其关联值的添加。将此属性设置为所需的参数值。
- property d¶
非对角线X衰减(Z衰减)。当最佳扩展分数与当前扩展分数之差大于i-j*A+int时停止扩展,其中i和j分别是查询和引用的当前位置,A是匹配分数。Z-Dropoff类似于BLAST的X-Dropoff,不同之处在于它不会惩罚比对中的一个序列中的间隙。Z衰减不仅可以避免不必要的延伸,还可以减少长而好的对齐中的不良对齐。 [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¶
引用文件名
这控制参考参数及其关联值的添加。将此属性设置为所需的参数值。
- 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)¶
-
Novocraft为novoalign提供的命令行包装。
参见www.novocraft.com-novoign是一个简短的读对齐程序。
示例
>>> 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(适配器3),但在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¶
优质基地最低数量 [default: 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¶
方法来报告具有多个匹配项的读取。
允许值:无、随机、全部、穷举、0.99“全部”和“穷举”接受限制。
这控制-r参数及其关联值的添加。将此属性设置为所需的参数值。
- property read_cal¶
从文件读取质量校准(不匹配计数)
这控制-k参数及其关联值的添加。将此属性设置为所需的参数值。
- property readfile¶
读取文件
这控制-f参数及其关联值的添加。将此属性设置为所需的参数值。
- property recorded¶
记录的路线得分等于最佳。
默认值:默认读取方式为1000,否则无限制。
这控制-e参数及其关联值的添加。将此属性设置为所需的参数值。
- property repeats¶
如果分数差异较大,则重复报告。
否则,将应用-r读取方法 [默认值:5]
这控制-R参数及其关联值的添加。将此属性设置为所需的参数值。
- property report¶
指定报告格式。
允许值:NATIVE、PARIWAY、SAM默认值:NATIVE
这控制-o参数及其关联值的添加。将此属性设置为所需的参数值。
- property threshold¶
对齐分数的阈值
这控制-t参数及其关联值的添加。将此属性设置为所需的参数值。
- property trimming¶
如果未能对齐,则按s个碱基进行修剪,直到它们映射或变得比l短。
默认值:2
这控制-s参数及其关联值的添加。将此属性设置为所需的参数值。
- property truncate¶
在对齐之前截断到特定长度
这控制-n参数及其关联值的添加。将此属性设置为所需的参数值。
- property unconverted¶
实验:亚硫酸氢盐模式下未转化的胞嘧啶惩罚
默认:不受处罚
这控制-u参数及其关联值的添加。将此属性设置为所需的参数值。
- property variation¶
结构变异罚金 [默认值:70]
这控制-v参数及其关联值的添加。将此属性设置为所需的参数值。
- property write_cal¶
累计不匹配计数并写入文件
这控制-K参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.SamtoolsViewCommandline(cmd='samtools', **kwargs)¶
-
Samtools视图的命令行包装。
以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¶
跳过位在整型中的对齐
这控制-F参数及其关联值的添加。将此属性设置为所需的参数值。
- property H¶
仅输出标题
此属性控制-H开关的添加,将此属性视为布尔值。
- property R¶
文件中列出的读取组中的输出读取
这控制-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小于整数的路线
这控制-q参数及其关联值的添加。将此属性设置为所需的参数值。
- property r¶
仅读取组STR中的输出读取
这控制-r参数及其关联值的添加。将此属性设置为所需的参数值。
- property region¶
区域
这将控制REGION参数及其关联值的添加。将此属性设置为所需的参数值。
- property t¶
- 此文件以制表符分隔。
每行必须包含引用名称和引用的长度,每个不同的引用占一行;其他字段将被忽略。
该文件还定义了排序中参考序列的顺序。如果运行‘Samtools faidx<ref.fa>’,则生成的索引文件<ref.fa>.fai可以用作此<in.ref_list>文件。
这控制-t参数及其关联值的添加。将此属性设置为所需的参数值。
- property u¶
输出未压缩的BAM。
此选项可节省压缩/解压缩所花费的时间,因此在将输出通过管道传输到另一个Samtools命令时是首选选项
此属性控制-u开关的添加,将此属性视为布尔值。
- class Bio.Sequencing.Applications.SamtoolsCalmdCommandline(cmd='samtools', **kwargs)¶
-
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调用方目前不支持=BASE。
此属性控制-e开关的添加,将此属性视为布尔值。
- property input_bam¶
输入BAM
这控制输入参数及其关联值的添加。将此属性设置为所需的参数值。
- property r¶
- 计算BQ标签(不带-A)
或用BAQ(带-A)表示封底质量。
此属性控制-r开关的添加,将此属性视为布尔值。
- property ref¶
要编制索引的参考FASTA
这控制参考参数及其关联值的添加。将此属性设置为所需的参数值。
- property u¶
输出未压缩的BAM
此属性控制-u开关的添加,将此属性视为布尔值。
- class Bio.Sequencing.Applications.SamtoolsCatCommandline(cmd='samtools', **kwargs)¶
-
Samtools cat的命令行包装。
串联BAMS,相当于::
$ 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)¶
-
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
这控制参考参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.SamtoolsFixmateCommandline(cmd='samtools', **kwargs)¶
-
Samtools fixmate的命令行包装器。
从按名称排序的路线中填写Mate坐标、ISIZE和Mate相关标志,相当于::
$ 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)¶
-
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)¶
-
Samtools索引的命令行包装。
用于快速随机访问的索引排序对齐,等同于::
$ 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)¶
-
Samtools合并的命令行包装。
合并多条排序路线,相当于:
$ 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¶
- 将文件行用作“@”
要复制到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)¶
-
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是读取碱基未对齐的按相位标度的概率。应用此选项极大地有助于减少未对齐导致的错误SNP
此属性控制-B开关的添加,将此属性视为布尔值。
- property C¶
- 地图质量降级系数
包含过多不匹配的读取。
给定具有从映射位置生成的按相位缩放的概率q的读取,新的映射质量约为sqrt((int-q)/int)*int。零值将禁用此功能;如果启用,则BWA的推荐值为50
这控制-C参数及其关联值的添加。将此属性设置为所需的参数值。
- property D¶
每样本输出读取深度
此属性控制-D开关的添加,将此属性视为布尔值。
- property E¶
- 扩展的BAQ计算。
此选项有助于敏感性,特别是对MNP,但可能会稍微损害特异性
此属性控制-E开关的添加,将此属性视为布尔值。
- property I¶
不执行Indel调用
此属性控制-i开关的添加,将此属性视为布尔值。
- property L¶
- 如果每个样本的平均值为
深度大于int
这控制-L参数及其关联值的添加。将此属性设置为所需的参数值。
- property M¶
以M为单位的封口贴图质量
这控制-M参数及其关联值的添加。将此属性设置为所需的参数值。
- property Q¶
要考虑的基础的最低基础质量
这控制-q参数及其关联值的添加。将此属性设置为所需的参数值。
- property S¶
- 按样本相位缩放的输出
绞线偏向P值
此属性控制-S开关的添加,将此属性视为布尔值。
- property b¶
输入BAM文件列表,每行一个文件
这控制-b参数及其关联值的添加。将此属性设置为所需的参数值。
- property d¶
在某个位置,每个输入BAM最多读取int个数据
这控制-d参数及其关联值的添加。将此属性设置为所需的参数值。
- property e¶
相位比例间隔扩展排序错误概率。
减小INT会导致更长的INDELS
这控制-e参数及其关联值的添加。将此属性设置为所需的参数值。
- property f¶
FASTA格式的FAIDX索引参考文件。
可以选择使用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¶
- 包含区域列表的床位或位置列表文件
或应生成堆积或BCF的站点
这控制-l参数及其关联值的添加。将此属性设置为所需的参数值。
- property o¶
相移比例的间隙开放排序错误概率。
减少int会导致更多的indel调用。
这控制-o参数及其关联值的添加。将此属性设置为所需的参数值。
- property p¶
- 逗号分隔的平台列表(由@RG-PL确定)
从其中获得INDELL候选。
建议从Indel错误率较低的测序技术(如Illumina)收集Indel候选
这控制-p参数及其关联值的添加。将此属性设置为所需的参数值。
- property q¶
要使用的路线的最低制图质量
这控制-q参数及其关联值的添加。将此属性设置为所需的参数值。
- property r¶
仅在区域STR中生成堆积
这控制-r参数及其关联值的添加。将此属性设置为所需的参数值。
- property u¶
- 与-g类似,不同之处在于输出为
未压缩的BCF,这是管道首选的
此属性控制-u开关的添加,将此属性视为布尔值。
- class Bio.Sequencing.Applications.SamtoolsPhaseCommandline(cmd='samtools', **kwargs)¶
-
Samtools阶段的命令行包装。
呼唤和相位杂合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¶
丢弃阶段不明确的读取
此属性控制-A开关的添加,将此属性视为布尔值。
- property F¶
不要尝试修复嵌合读取
此属性控制-F开关的添加,将此属性视为布尔值。
- property Q¶
- 最低基本质量为
在HET通话中使用
这控制-q参数及其关联值的添加。将此属性设置为所需的参数值。
- property b¶
BAM输出的前缀
这控制-b参数及其关联值的添加。将此属性设置为所需的参数值。
- property in_bam¶
输入文件
这控制输入参数及其关联值的添加。将此属性设置为所需的参数值。
- property k¶
本地相位的最大长度
这控制-k参数及其关联值的添加。将此属性设置为所需的参数值。
- property q¶
- 最小相位缩放详细等级至
称杂合子为杂合子
这控制-q参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.SamtoolsReheaderCommandline(cmd='samtools', **kwargs)¶
-
Samtools重新标头的命令行包装。
将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)¶
-
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¶
- 处理成对端读取
作为单端读取
此属性控制-S开关的添加,将此属性视为布尔值。
- property input_file¶
命名已排序的路线文件
这控制in_bam参数及其关联值的添加。将此属性设置为所需的参数值。
- property output_file¶
输出文件
这控制out_bam参数及其关联值的添加。将此属性设置为所需的参数值。
- property s¶
删除单端读取的重复项。
默认情况下,该命令仅适用于成对端读取
此属性控制-s开关的添加,将此属性视为布尔值。
- Bio.Sequencing.Applications.SamtoolsSortCommandline¶
- class Bio.Sequencing.Applications.SamtoolsVersion0xSortCommandline(cmd='samtools', **kwargs)¶
-
Samtools版本0.1.x的命令行包装排序。
串联BAMS,相当于::
$ 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¶
- 而不是按已读名称排序
而不是通过染色体坐标
此属性控制-n开关的添加,将此属性视为布尔值。
- property o¶
- 输出最终对齐
转换为标准输出
此属性控制-o开关的添加,将此属性视为布尔值。
- property out_prefix¶
输出前缀
这控制OUT_PREFIX参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.SamtoolsVersion1xSortCommandline(cmd='samtools', **kwargs)¶
-
Samtools版本1.3.x的命令行包装器排序。
串联BAMS,相当于::
$ 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¶
(格式)将最终输出写为Sam、bam或crm
这控制-O参数及其关联值的添加。将此属性设置为所需的参数值。
- property T¶
- (前缀)将临时文件写入PREFIX.nnn.bam,或者如果指定的前缀
是一个现有目录,前缀为/samtools.mmm.mmm.tmp.nnn.bam,其中mmm对于这次调用排序命令是唯一的
这控制-T参数及其关联值的添加。将此属性设置为所需的参数值。
- property input¶
输入SAM/BAM/CRAM文件
这控制输入参数及其关联值的添加。将此属性设置为所需的参数值。
- property m¶
大约所需的最大内存
这控制-m参数及其关联值的添加。将此属性设置为所需的参数值。
- property n¶
- 而不是按已读名称排序
而不是通过染色体坐标
此属性控制-n开关的添加,将此属性视为布尔值。
- property o¶
- (文件)将最终排序的输出写入文件,
而不是标准输出
这控制-o参数及其关联值的添加。将此属性设置为所需的参数值。
- class Bio.Sequencing.Applications.SamtoolsTargetcutCommandline(cmd='samtools', **kwargs)¶
-
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¶
这控制参数及其关联值的添加。将此属性设置为所需的参数值。
- property em2¶
这控制参数及其关联值的添加。将此属性设置为所需的参数值。
- property f¶
引用文件名
这控制-f参数及其关联值的添加。将此属性设置为所需的参数值。
- property i¶
插入罚金
这控制-i参数及其关联值的添加。将此属性设置为所需的参数值。
- property in_bam¶
输入文件
这控制输入参数及其关联值的添加。将此属性设置为所需的参数值。