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

輸出資料庫的前綴 [與資料庫檔案名稱相同]

這會控制 -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

不允許在 3' 端 INT bp 內出現長刪除 [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，其中 l 是原始讀取長度，則 BWA 將讀取修剪為 argmax_x{sum_{i=x+1}^l(INT-q_i)}。

此設定控制 -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) 或透過 Biopython 教學中描述的 Python subprocess 模組執行命令列。

__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) 或透過 Biopython 教學中描述的 Python subprocess 模組執行命令列。

__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 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 sai_file2

Sai 檔案 2

這控制了 sai_file2 參數及其相關值的添加。將此屬性設定為所需的參數值。

類別 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 subprocess 模組執行命令列，如 Biopython 教學中所述。

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

屬性 N

支援跳過反向比對的結果比對的最小種子數量。[5]

此設定控制 -N 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 T

最小分數閾值除以 a [37]

這控制了 -T 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 a

匹配的分數 [1]

這會控制 -a 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 b

不匹配的懲罰 [3]

這控制了 -b 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 c

根據查詢長度調整閾值的係數 [5.5]。

給定一個長度為 l 的查詢，保留命中所需的閾值為 a*max{T,c*log(l)}。

這控制了 -c 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 mate_file

配對檔案

這控制了 mate_file 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 q

間隙開啟懲罰 [5]

此設定控制 -q 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 r

間隙延伸懲罰。大小為 k 的連續間隙的懲罰為 q+k*r。[2]

此設定控制 -r 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 read_file

讀取檔案

此設定控制 read_file 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 reference

參考檔案名稱

此設定控制 reference 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 s

初始化種子的最大 SA 間隔大小 [3]。

較高的 -s 會提高準確度，但會犧牲速度。

這控制了 -s 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 t

多執行緒模式中的執行緒數量 [1]

此設定控制 -t 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 w

帶狀比對中的頻寬 [33]

這控制了 -w 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 z

Z-best 啟發式方法。較高的 -z 會提高準確度，但會犧牲速度。[1]

這控制了 -z 參數及其相關值的添加。將此屬性設定為所需的參數值。

類別 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 subprocess 模組執行命令列，如 Biopython 教學中所述。

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

屬性 A

匹配分數。[1]

這控制了 -A 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 B

不匹配的懲罰。序列錯誤率約為：{.75 * exp[-log(4) * B/A]}。[4]

這會控制 -B 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 C

將 FASTA/Q 註解附加到 SAM 輸出。此選項可用於將讀取元資訊 (例如，條碼) 傳輸到 SAM 輸出。請注意，FASTA/Q 註解 (標頭行中空格後的字串) 必須符合 SAM 規範 (例如，BC:Z:CGTAC)。格式不正確的註解會導致不正確的 SAM 輸出。

此屬性控制 -C 開關的添加，將此屬性視為布林值。

屬性 E

間隙延伸懲罰。長度為 k 的間隙代價為 O + k*E (即，-O 用於開啟零長度間隙)。[1]

這會控制 -E 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 H

在 SAM 輸出中使用硬剪切 'H'。當映射長重疊群或 BAC 序列時，此選項可以顯著減少輸出的冗餘。

此屬性控制 -H 開關的添加，將此屬性視為布林值。

屬性 L

剪切懲罰。執行 SW 延伸時，BWA-MEM 會追蹤達到查詢結尾的最佳分數。如果此分數大於最佳 SW 分數減去剪切懲罰，則不會應用剪切。請注意，在這種情況下，SAM AS 標籤會報告最佳 SW 分數；不會扣除剪切懲罰。[5]

這控制了 -L 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 M

將較短的分割命中標記為次要 (為了與 Picard 相容)。

此屬性控制 -M 開關的添加，將此屬性視為布林值。

屬性 O

間隙開啟懲罰。[6]

這會控制 -O 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 P

在雙端模式下，只執行 SW 以搶救遺失的命中，但不嘗試尋找符合正確配對的命中。

此屬性控制 -P 開關的添加，將此屬性視為布林值。

屬性 R

完整的讀取群組標頭行。't' 可以在 STR 中使用，並在輸出 SAM 中轉換為 TAB。讀取群組 ID 將附加到輸出中的每個讀取。範例為 ‘@RG ID:foo SM:bar’。[null]

這會控制 -R 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 T

不要輸出分數低於 INT 的比對結果。此選項僅影響輸出。[30]

這控制了 -T 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 U

不成對讀取片段的懲罰值。BWA-MEM 將不成對的讀取片段評分為 scoreRead1+scoreRead2-INT，而將成對的評分為 scoreRead1+scoreRead2-insertPenalty。它會比較這兩個分數，以判斷是否應強制配對。[9]

此選項控制 -U 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 a

輸出單端或不成對雙端讀取的所有找到的比對結果。這些比對結果將被標記為次要比對。

此屬性控制 -a 開關的添加，將此屬性視為布林值。

屬性 c

如果一個 MEM 在基因組中出現次數超過 INT，則將其丟棄。這是一個不敏感的參數。[10000]

這控制了 -c 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 d

非對角 X-dropoff (Z-dropoff)。當最佳分數和當前延伸分數之間的差異大於 |i-j|*A+INT 時停止延伸，其中 i 和 j 分別是查詢和參考的當前位置，A 是匹配分數。Z-dropoff 類似於 BLAST 的 X-dropoff，但它不會懲罰比對中其中一個序列的間隙。Z-dropoff 不僅避免了不必要的延伸，還減少了長良好比對內部的不良比對。[100]

這會控制 -d 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 k

最小種子長度。短於 INT 的匹配將會遺漏。除非顯著偏離 20，否則比對速度通常對此值不敏感。[19]

此設定控制 -k 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 p

假設第一個輸入查詢文件是交錯的雙端 FASTA/Q。有關詳細資訊，請參閱命令描述。

此屬性控制 -p 開關的添加，將此屬性視為布林值。

屬性 r

觸發重新植種以產生長度大於 minSeedLen*FLOAT 的 MEM。這是調整效能的關鍵啟發式參數。較大的值會產生較少的種子，這會導致更快的比對速度但較低的準確性。[1.5]

此設定控制 -r 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 read_file1

讀取 1 檔案名稱

此設定控制 read_file1 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 read_file2

讀取 2 檔案名稱

此設定控制 read_file2 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 reference

參考檔案名稱

此設定控制 reference 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 t

執行緒數目 [1]

此設定控制 -t 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 v

控制輸出的詳細程度。此選項在整個 BWA 中尚未完全支援。理想情況下，值 0 表示停用所有 stderr 輸出；1 表示僅輸出錯誤；2 表示警告和錯誤；3 表示所有正常訊息；4 或更高表示偵錯。當此選項的值為 4 時，輸出不是 SAM。[3]

此選項控制 -v 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 w

頻寬。基本上，找不到長於 INT 的間隙。請注意，最大間隙長度也受評分矩陣和命中長度影響，而不僅僅由此選項決定。[100]

這控制了 -w 參數及其相關值的添加。將此屬性設定為所需的參數值。

類別 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 subprocess 模組執行命令列，如 Biopython 教學課程中所述。

上次檢查的版本：2.05.04

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

屬性 adapter3

在比對之前移除 3' 接頭序列。

對於雙端讀取，可以指定兩個接頭

這會控制 -a 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 adapter5

移除 5' 接頭序列。

與 -a (adaptor3) 類似，但位於 5' 端。

此選項控制 -5 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 cores

執行緒數目，在免費版本上停用 [預設：核心數目]

這控制了 -c 參數及其相關值的添加。將此屬性設定為所需的參數值。

屬性 database

資料庫檔案名稱

這會控制 -d 參數及其相關值的添加。將此屬性設定為所需的引數值。

屬性 format

讀取檔案的格式。

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

此選項控制 -F 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 fragment

片段長度 (2 個讀取 + 插入) 和標準差 [預設：250 30]

此設定控制 -i 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 gap_extend

間隙延伸懲罰 [預設：15]

此選項控制 -x 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 gap_open

間隙開啟懲罰 [預設：40]

此選項控制 -g 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 good_bases

最小良好品質鹼基數 [預設：log(N_g, 4) + 5]

此設定控制 -l 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 homopolymer

同聚物讀取篩選器 [預設：20；停用：負值]

此選項控制 -h 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 miRNA

設定 miRNA 模式並可選擇設定掃描區域的值 [預設：關閉]

此選項控制 -m 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 qual_digits

品質分數的小數位數 [預設：0]

此設定控制 -q 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 quality

回報比對的下限 [預設：0]

此選項控制 -Q 參數的添加及其相關值。將此屬性設定為所需的參數值。

屬性 r_method

回報具有多個匹配項的讀取的方法。

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

此設定控制 -r 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 read_cal

從檔案 (不匹配計數) 校正讀取品質

此設定控制 -k 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 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 短。

預設值：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

僅輸出 FLAG 欄位中存在 INT 中所有位元的比對結果: 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

區域

此屬性控制 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

用於降級包含過多錯配的讀取的

比對品質的係數。

給定一個讀取，其 phred 尺度機率 q 是從對應位置產生，新的對應品質大約是 sqrt((INT-q)/INT)*INT。零值會停用此功能；如果啟用，BWA 的建議值為 50

此屬性控制 -C 參數及其關聯值的加入。將此屬性設定為所需的參數值。

property D

輸出每個樣本的讀取深度

此屬性控制 -D 開關的添加，請將此屬性視為布林值。

property E

延伸 BAQ 計算。: 此選項有助於提高靈敏度，尤其適用於 MNPs，但可能會稍微損害特異性

此屬性控制 -E 開關的加入，將此屬性視為布林值。

property I

不執行 INDEL 偵測

此屬性控制 -I 開關的添加，將此屬性視為布林值。

property L

如果每個樣本的平均: 深度高於 INT，則跳過 INDEL 偵測

這控制了 -L 參數及其相關值的添加。將此屬性設定為所需的參數值。

property M

將對應品質上限設定為 M

這會控制 -M 參數及其相關值的添加。將此屬性設定為所需的引數值。

property Q

要被視為鹼基的最低鹼基品質

此選項控制 -Q 參數的添加及其相關值。將此屬性設定為所需的參數值。

property S

輸出每個樣本的 Phred 尺度: 鏈偏差 P 值

此屬性控制 -S 開關的加入，將此屬性視為布林值。

property b

輸入 BAM 檔案清單，每行一個檔案

這控制了 -b 參數及其相關值的添加。將此屬性設定為所需的參數值。

property d

在一個位置，每個輸入 BAM 最多讀取 INT 個讀取

這會控制 -d 參數及其相關值的添加。將此屬性設定為所需的引數值。

property e

Phred 尺度的間隙延伸定序錯誤機率。

降低 INT 會導致更長的插入缺失

這會控制 -e 參數及其相關值的添加。將此屬性設定為所需的引數值。

property f

FASTA 格式的 faidx 索引參考檔案。

該檔案可以選擇使用 razip 壓縮

此屬性控制 -f 參數及其關聯值的加入。將此屬性設定為所需的參數值。

property g

計算基因型概似值，並以: 二進制呼叫格式 (BCF) 輸出

此屬性控制 -g 開關的添加，請將此屬性視為布林值。

property h

用於建立同聚物錯誤模型的係數。

給定一個長度為 l 的同聚物運行，大小為 s 的插入缺失的定序錯誤被建模為 INT*s/l

此選項控制 -h 參數的添加及其相關值。將此屬性設定為所需的參數值。

property illumina_13

假設品質是使用 Illumina 1.3+ 編碼

此屬性控制 -6 開關的添加，請將此屬性視為布林值。

property input_file

用於產生 mpileup 的輸入檔案

這會控制 input_file 參數及其相關值的添加。將此屬性設定為所需的引數值。

property l

包含應產生 pileup 或 BCF 的區域或位置列表的 BED 或位置列表檔案: 或位點

此設定控制 -l 參數及其相關值的添加。請將此屬性設定為所需參數值。

property o

Phred 尺度的間隙開啟定序錯誤機率。

降低 INT 會導致更多的插入缺失呼叫。

此設定控制 -o 參數及其相關值的添加。請將此屬性設定為所需參數值。

property p

從中取得插入缺失候選項的平台逗號分隔列表 (由 @RG-PL 決定)。

建議從具有低插入缺失錯誤率的定序技術（例如 ILLUMINA）收集插入缺失候選項

例如 ILLUMINA

這會控制 -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

丟棄具有模糊相位的讀取

此屬性控制 -A 開關的加入，將此屬性視為布林值。

property F

不嘗試修復嵌合讀取

此屬性控制 -F 開關的添加，請將此屬性視為布林值。

property Q

在雜合呼叫中要: 使用的最低鹼基品質

此選項控制 -Q 參數的添加及其相關值。將此屬性設定為所需的參數值。

property b

BAM 輸出的前綴

這控制了 -b 參數及其相關值的添加。將此屬性設定為所需的參數值。

property in_bam

輸入檔案

此屬性控制輸入參數及其關聯值的加入。將此屬性設定為所需的參數值。

property k

局部定相的最大長度

此設定控制 -k 參數及其相關值的添加。請將此屬性設定為所需參數值。

property q

用於呼叫雜合子的: 最低 Phred 尺度 LOD

此設定控制 -q 參數及其相關值的添加。請將此屬性設定為所需參數值。

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

基底類別： AbstractCommandline

samtools reheader 的命令行包裝器。

將 in.bam 中的 header 替換為 in.header.sam 中的 header，等同於

$ 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

要寫入 header 的 BAM 檔案

這控制 input_bam 參數及其相關值的添加。將此屬性設定為所需的引數值。

property sam_file

帶有 header 的 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

將成對末端讀取視為單末端讀取: 。

此屬性控制 -S 開關的加入，將此屬性視為布林值。

property input_file

名稱排序的比對檔案

這控制 in_bam 參數及其相關值的添加。將此屬性設定為所需的引數值。

property output_file

輸出檔案

這控制 out_bam 參數及其相關值的添加。將此屬性設定為所需的引數值。

property s

移除單末端讀取的重複序列。

預設情況下，該命令僅適用於成對末端讀取

此屬性控制 -s 切換的添加，將此屬性視為布林值。

Bio.Sequencing.Applications.SamtoolsSortCommandline: SamtoolsVersion0xSortCommandline 的別名

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

基底類別： AbstractCommandline

samtools 0.1.x 版本排序的命令行包裝器。

串連 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

依讀取名稱排序，而不是: 依染色體座標排序

此屬性控制 -n 開關的添加，請將此屬性視為布林值。

property o

將最終對齊結果: 輸出到標準輸出

此屬性控制 -o 切換的添加，將此屬性視為布林值。

property out_prefix

輸出前綴

此屬性控制 out_prefix 參數及其相關值的加入。將此屬性設定為所需的參數值。

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

基底類別： AbstractCommandline

samtools 1.3.x 版本排序的命令行包裝器。

串連 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 是此排序命令調用獨有的。

這控制了 -T 參數及其相關值的添加。將此屬性設定為所需的參數值。

property input

輸入 SAM/BAM/CRAM 檔案

此屬性控制輸入參數及其關聯值的加入。將此屬性設定為所需的參數值。

property m

約略的最大所需記憶體

此選項控制 -m 參數的添加及其相關值。將此屬性設定為所需的參數值。

property n

依讀取名稱排序，而不是: 依染色體座標排序

此屬性控制 -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 參數及其相關值。請將此屬性設定為所需的參數值。

屬性 f

參考檔名

此屬性控制 -f 參數及其關聯值的加入。將此屬性設定為所需的參數值。

屬性 i

插入懲罰值

此設定控制 -i 參數及其相關值的添加。請將此屬性設定為所需參數值。

屬性 in_bam

輸入檔案

此屬性控制輸入參數及其關聯值的加入。將此屬性設定為所需的參數值。