pacbio_germline
请注意,Parabricks GPU 加速的 pacbio_germline 工具目前处于 Beta 测试阶段。
运行种系变异工具,以使用 minimap2 进行比对以及 DeepVariant 变异调用器,在长读序序列上生成 BAM 和变异。
请参阅 pacbio_germline 参考 部分,获取所有可用选项的详细列表。
# This command assumes all the inputs are in INPUT_DIR and all the outputs go to OUTPUT_DIR.
docker run --rm --gpus all --volume INPUT_DIR:/workdir --volume OUTPUT_DIR:/outputdir \
--workdir /workdir \
nvcr.io/nvidia/clara/clara-parabricks:4.4.0-1 \
pbrun pacbio_germline \
--ref /workdir/${REFERENCE_FILE} \
--in-fq /workdir/${INPUT_FASTQ} \
--out-bam /outputdir/${OUTPUT_BAM} \
--out-variants /outputdir/${OUTPUT_VCF}
以下命令是 Clara Parabricks 上述命令的 minimap2-v2.26、GATK4 和 Google DeepVariant 对等命令。这些命令的输出将与上述命令的输出相同。请参阅输出比较页面,以比较结果。
# Run minimap2 and pipe the output to create a sorted BAM.
$ minimap2 -ax map-pbmm2 \
<INPUT_DIR>/${REFERENCE_FILE} \
<INPUT_DIR>/${INPUT_FASTQ} | \
gatk SortSam \
--java-options -Xmx30g \
--MAX_RECORDS_IN_RAM 5000000 \
-I /dev/stdin \
-O cpu.bam \
--SORT_ORDER coordinate
# Run deepvariant
BIN_VERSION="1.6.1"
sudo docker run \
-v "${PWD}":"/input" \
-v "${PWD}/output":"/output" \
-v "${PWD}/Ref":"/reference" \
google/deepvariant:"${BIN_VERSION}" \
/opt/deepvariant/bin/run_deepvariant \
--model_type PACBIO \
--ref /reference/${REFERENCE_FILE} \
--reads cpu.bam \
--output_vcf /output/"${OUTPUT_VCF_FILE}" \
--num_shards $(nproc) \
--make_examples_extra_args "ws_use_window_selector_model=true"
请注意,必须对基线 minimap2 代码进行两处更改才能完全匹配结果
首先,必须在 options.c
的 mm_set_opt
函数中创建一个新的预设,尝试通过将这些参数设置为名为“map-pbmm2”的新预设来复制 pbmm2 的预设
io->k = 19;
io->w = 19;
io->batch_size = 0x7fffffffffffffffL; // always build a uni-part index
mo->flag |= MM_F_CIGAR;
mo->flag |= MM_F_SOFTCLIP;
mo->flag |= MM_F_LONG_CIGAR;
mo->flag |= MM_F_EQX;
mo->flag |= MM_F_NO_PRINT_2ND; // Allow secondaries with enforced mapping, but disable per default!
mo->zdrop = 400;
mo->zdrop_inv = 50;
mo->a = 1;
mo->b = 4;
mo->q = 6;
mo->q2 = 26;
mo->e = 2;
mo->e2 = 1;
mo->bw = 2000;
mo->max_gap = 10000;
mo->occ_dist = 500;
mo->min_mid_occ = 50;
mo->max_mid_occ = 500;
mo->min_dp_max = 500;
其次,必须对基线 KSW2 代码进行修复,以通过将循环裂变起点和终点更改为 st
和 en
分别对其进行舍入。如果起点 (st0
) 是小于 16 但大于 0 的数字,则其评分值将不会正确初始化,但在稍后计算实际比对时仍将使用。可以通过将起点和终点舍入为 16 的倍数来解决此问题。
要进行此修复,请更改 ksw2_extd2_sse.c
中的以下代码
// loop fission: set scores first
if (!(flag & KSW_EZ_GENERIC_SC)) {
for (t = st0; t <= en0; t += 16) {
__m128i sq, st, tmp, mask;
sq = _mm_loadu_si128((__m128i*)&sf[t]);
st = _mm_loadu_si128((__m128i*)&qrr[t]);
mask = _mm_or_si128(_mm_cmpeq_epi8(sq, m1_), _mm_cmpeq_epi8(st, m1_));
tmp = _mm_cmpeq_epi8(sq, st);
#ifdef __SSE4_1__
tmp = _mm_blendv_epi8(sc_mis_, sc_mch_, tmp);
tmp = _mm_blendv_epi8(tmp, sc_N_, mask);
#else
tmp = _mm_or_si128(_mm_andnot_si128(tmp, sc_mis_), _mm_and_si128(tmp, sc_mch_));
tmp = _mm_or_si128(_mm_andnot_si128(mask, tmp), _mm_and_si128(mask, sc_N_));
#endif
_mm_storeu_si128((__m128i*)((int8_t*)s + t), tmp);
}
} else {
for (t = st0; t <= en0; ++t)
((uint8_t*)s)[t] = mat[sf[t] * m + qrr[t]];
}
使用 lf_start
和 lf_en
的固定版本
// loop fission: set scores first
int lf_start = st, lf_en = en;
if (!(flag & KSW_EZ_GENERIC_SC)) {
for (t = lf_start; t <= lf_en; t += 16) {
__m128i sq, st, tmp, mask;
sq = _mm_loadu_si128((__m128i*)&sf[t]);
st = _mm_loadu_si128((__m128i*)&qrr[t]);
mask = _mm_or_si128(_mm_cmpeq_epi8(sq, m1_), _mm_cmpeq_epi8(st, m1_));
tmp = _mm_cmpeq_epi8(sq, st);
#ifdef __SSE4_1__
tmp = _mm_blendv_epi8(sc_mis_, sc_mch_, tmp);
tmp = _mm_blendv_epi8(tmp, sc_N_, mask);
#else
tmp = _mm_or_si128(_mm_andnot_si128(tmp, sc_mis_), _mm_and_si128(tmp, sc_mch_));
tmp = _mm_or_si128(_mm_andnot_si128(mask, tmp), _mm_and_si128(mask, sc_N_));
#endif
_mm_storeu_si128((__m128i*)((int8_t*)s + t), tmp);
}
} else {
for (t = lf_start; t <= lf_en; ++t)
((uint8_t*)s)[t] = mat[sf[t] * m + qrr[t]];
}
有关下载和使用额外 GPU 的模型文件的说明,请参阅 DeepVariant 用于额外 GPU 的模型 部分。
通过使用 minimap2 比对长读序序列并使用深度神经网络分析,从 FASTQ/BAM 运行到 VCF 的种系管道。
输入/输出文件选项
- --ref REF
-
参考文件的路径。(默认值:None)
此选项为必填项。
- --index INDEX
-
由 vanilla minimap2 生成的最小化指标文件的路径,用于减少索引时间。(默认值:None)
- --in-fq IN_FQ
-
fastq 或 fastq.gz 格式的查询序列文件的路径。(默认值:None)
- --in-bam IN_BAM
-
输入 BAM/CRAM 文件的路径。(默认值:None)
- --knownSites KNOWNSITES
-
已知插入缺失文件的路径。该文件必须为 vcf.gz 格式。此选项可以多次使用。(默认值:None)
- --interval-file INTERVAL_FILE
-
以下格式之一的间隔文件的路径:Picard 样式(.interval_list 或 .picard)、GATK 样式(.list 或 .intervals)或 BED 文件(.bed)。此选项可以多次使用。(默认值:None)
- --pb-model-file PB_MODEL_FILE
-
deepvariant 的非默认 parabricks 模型文件的路径。(默认值:None)
- --out-recal-file OUT_RECAL_FILE
-
碱基质量分数重新校准后报告文件的路径。(默认值:None)
- --out-bam OUT_BAM
-
标记重复项后 BAM 文件的路径。(默认值:None)
此选项为必填项。
- --out-variants OUT_VARIANTS
-
变异调用后 vcf/gvcf/gvcf.gz 文件的路径。(默认值:None)
此选项为必填项。
- --out-duplicate-metrics OUT_DUPLICATE_METRICS
-
标记重复项后重复指标文件的路径。(默认值:None)
- --proposed-variants PROPOSED_VARIANTS
-
VCF 文件的路径,其中包含用于生成示例阶段的建议变异。(默认值:None)
工具选项
- --preset PRESET
-
要应用的预设。可能的值为 {map-pbmm2,map-hifi,map-ont}。(默认值:map-pbmm2)
- --pbmm2
-
包含额外的处理以匹配 pbmm2 的格式和准确性。与 map-ont --preset 值不兼容。(默认值:None)
- --pbmm2-unmapped
-
在 pbmm2 的输出中包含未比对的记录。必须与 --pbmm2 同时使用。与 map-ont --preset 值不兼容。(默认值:None)
- --eqx
-
写入 =/X CIGAR 运算符。(默认值:None)
- -L INTERVAL, --interval INTERVAL
-
从中调用输入读取的 bqsr 的间隔。所有间隔都将具有 100 的填充以获取读取记录,并且重叠的间隔将被合并。间隔文件应使用 --interval-file 选项传递。此选项可以多次使用(例如“-L chr1 -L chr2:10000 -L chr3:20000+ -L chr4:10000-20000”)。(默认值:None)
- -ip INTERVAL_PADDING, --interval-padding INTERVAL_PADDING
-
要添加到您包含的每个间隔的填充量(以碱基对为单位)。(默认值:None)
- --standalone-bqsr
-
在生成排序后的 BAM 后运行独立的 BQSR。此选项需要 --knownSites 和 --out-recal-file 输入参数。(默认值:None)
- --read-group-sm READ_GROUP_SM
-
此运行中读取组的 SM 标签。(默认值:None)
- --read-group-lb READ_GROUP_LB
-
此运行中读取组的 LB 标签。(默认值:None)
- --read-group-pl READ_GROUP_PL
-
此运行中读取组的 PL 标签。(默认值:None)
- --read-group-id-prefix READ_GROUP_ID_PREFIX
-
此运行中读取组的 ID 和 PU 标签的前缀。此前缀将用于此运行中所有成对的 fastq 文件。ID 和 PU 标签将由此前缀和一个标识符组成,该标识符对于一对 fastq 文件而言是唯一的。(默认值:None)
- --disable-use-window-selector-model
-
将窗口选择器模型从等位基因计数线性更改为变异读取。此选项将提高准确性和运行时间。(默认值:None)
- --gvcf
-
以 .gvcf 格式生成变异调用。(默认值:None)
- --norealign-reads
-
在调用变异之前,不局部重新比对读取。长度超过 500 bp 的读取永远不会重新比对。(默认值:None)
- --sort-by-haplotypes
-
读取按单倍型(使用 HP 标签)排序。(默认值:None)
- --keep-duplicates
-
保留重复的读取。(默认值:None)
- --vsc-min-count-snps VSC_MIN_COUNT_SNPS
-
在等位基因计数中至少出现此次数的 SNP 等位基因将被提升为候选基因。(默认值:2)
- --vsc-min-count-indels VSC_MIN_COUNT_INDELS
-
在等位基因计数中至少出现此次数的 Indel 等位基因将被提升为候选基因。(默认值:2)
- --vsc-min-fraction-snps VSC_MIN_FRACTION_SNPS
-
在等位基因计数中至少占所有计数此分数的 SNP 等位基因将被提升为候选基因。(默认值:0.12)
- --vsc-min-fraction-indels VSC_MIN_FRACTION_INDELS
-
在等位基因计数中至少占所有计数此分数的 Indel 等位基因将被提升为候选基因。(默认值:None)
- --min-mapping-quality MIN_MAPPING_QUALITY
-
默认情况下,保留具有任何比对质量的读取。将此字段设置为正整数 i 将仅保留 MAPQ >= i 的读取。请注意,这仅适用于比对的读取。(默认值:5)
- --min-base-quality MIN_BASE_QUALITY
-
最低碱基质量。此选项对备择等位基因强制执行最低碱基质量分数。仅当等位基因中的所有碱基的质量都大于 min_base_quality 时,才会考虑备择等位基因。(默认值:10)
- --alt-aligned-pileup ALT_ALIGNED_PILEUP
-
值可以是 [none, diff_channels] 之一。在 pileup 图像中包含针对每个候选备择等位基因的读取比对。(默认值:None)
- --variant-caller VARIANT_CALLER
-
值可以是 [VERY_SENSITIVE_CALLER, VCF_CANDIDATE_IMPORTER] 之一。用于生成示例的调用器。如果使用 VCF_CANDIDATE_IMPORTER,则意味着强制调用。默认值为 VERY_SENSITIVE_CALLER。(默认值:None)
- --add-hp-channel
-
添加另一个通道以表示每个读取的 HP 标签。(默认值:None)
- --parse-sam-aux-fields
-
将解析 BAM/CRAM 记录的辅助字段。如果设置了 --sort-by-haplotypes 或 --add-hp-channel,则也必须设置此选项。(默认值:None)
- --use-wes-model
-
如果传递此参数,将使用 WES 模型文件。仅在 shortread 模式下使用。(默认值:None)
- --include-med-dp
-
如果为 True,则在输出 gVCF 记录中包含 MED_DP。(默认值:None)
- --normalize-reads
-
如果为 True,则等位基因计数器左对齐每个读取的 INDEL。(默认值:None)
- --pileup-image-width PILEUP_IMAGE_WIDTH
-
Pileup 图像宽度。仅当您知道您的模型支持此宽度时才更改此设置。(默认值:221)
- --channel-insert-size
-
如果为 True,则将 insert_size 通道添加到 pileup 图像中。默认情况下,此参数在 WGS 和 WES 模式下为 true。(默认值:None)
- --no-channel-insert-size
-
如果为 True,则不要将 insert_size 通道添加到 pileup 图像中。(默认值:None)
- --max-read-size-512
-
允许 deepvariant 在大小为 512bp 的读取上运行。默认大小为 320 bp。(默认值:None)
- --prealign-helper-thread
-
为预对齐步骤使用额外的线程。当设置 --max-reads-size-512 时,此参数更有用。(默认值:None)
- --track-ref-reads
-
如果为 True,则等位基因计数器会跟踪支持 ref 的读取。默认情况下,等位基因计数器仅保留支持 ref 的读取数量的简单计数。(默认值:None)
- --phase-reads
-
自动计算相位并将 HP 标签添加到所有读取。(默认值:None)
- --dbg-min-base-quality DBG_MIN_BASE_QUALITY
-
要考虑的 k-mer 序列中的最小碱基质量。(默认值:15)
- --ws-min-windows-distance WS_MIN_WINDOWS_DISTANCE
-
用于局部组装的候选窗口之间的最小距离(默认值:80)
- --channel-gc-content
-
如果为 True,则将 gc_content 通道添加到 pileup 图像中(默认值:None)
- --channel-hmer-deletion-quality
-
如果为 True,则将 hmer 删除质量通道添加到 pileup 图像中(默认值:None)
- --channel-hmer-insertion-quality
-
如果为 True,则将 hmer 插入质量通道添加到 pileup 图像中(默认值:None)
- --channel-non-hmer-insertion-quality
-
如果为 True,则将 non-hmer 插入质量通道添加到 pileup 图像中(默认值:None)
- --skip-bq-channel
-
如果为 True,则忽略碱基质量通道。(默认值:None)
- --aux-fields-to-keep AUX_FIELDS_TO_KEEP
-
要保留的辅助 BAM 字段的逗号分隔列表。值可以是 [HP, tp, t0](默认值:HP)
- --vsc-min-fraction-hmer-indels VSC_MIN_FRACTION_HMER_INDELS
-
至少发生此次数的 Hmer Indel 等位基因将被提升为候选基因。如果应区别对待 hmer 和 non-hmer indel(Ultima 读取),请使用此阈值。默认值将对 hmer 和 non-hmer indel 使用相同的阈值,如 vsc_min_fraction_indels 中定义。(默认值:None)
- --vsc-turn-on-non-hmer-ins-proxy-support
-
从软剪切读取和其他 non-hmer 插入等位基因向最常见的 non-hmer 插入等位基因添加读取支持。(默认值:None)
- --consider-strand-bias
-
如果为 True,则在调用中期望 SB 字段并将其写入 VCF。(默认值:None)
- --p-error P_ERROR
-
参考置信度模型的碱基检出错误。(默认值:0.001)
- --channel-ins-size
-
如果为 true,则添加另一个通道以表示插入的大小。(适用于基于流的测序)(默认值:None)
- --max-ins-size MAX_INS_SIZE
-
ins_size_channel 的最大插入大小,更大的插入将看起来像最大值(具有最大强度)(默认值:10)
- --disable-group-variants
-
如果使用 vcf_candidate_importer 并且多等位基因位点在 VCF 中跨多行拆分,请设置为 True,以便在将 CallVariantsOutput 转换为 Variants 时不会对变异进行分组。(默认值:None)
- --filter-reads-too-long
-
忽略所有大小 > 512bp 的输入 BAM 读取(默认值:None)
- --haploid-contigs HAPLOID_CONTIGS
-
非常染色体染色体的可选列表。对于所有列出的染色体,不考虑 HET 概率。(默认值:None)
性能选项
- --num-threads NUM_THREADS
-
处理线程数。(默认值:12)
- --gpuwrite
-
使用一个 GPU 加速写入最终 BAM/CRAM。(默认值:None)
- --gpuwrite-deflate-algo GPUWRITE_DEFLATE_ALGO
-
选择要与 --gpuwrite 一起使用的 nvCOMP DEFLATE 算法。请注意,这些选项与 CPU DEFLATE 选项不对应。有效选项为 1、2 和 4。选项 1 最快,而选项 2 和 4 的吞吐量逐渐降低,但压缩率更高。当用户未提供输入时(即 None),默认值为 1(默认值:None)
- --gpusort
-
使用 GPU 加速排序。(默认值:None)
- --use-gds
-
使用 GPUDirect Storage (GDS) 来启用直接数据路径,以实现 GPU 内存和存储之间的直接内存访问 (DMA) 传输。必须与 --gpuwrite 同时使用。有关如何设置和使用 GPUDirect Storage 的信息,请参阅 Parabricks 文档 > 最佳性能。(默认值:None)
- --low-memory
-
使用低内存模式(默认值:None)
- --num-cpu-threads-per-stream NUM_CPU_THREADS_PER_STREAM
-
每个流要使用的 CPU 线程数。(默认值:6)
- --num-streams-per-gpu NUM_STREAMS_PER_GPU
-
每个 GPU 要使用的流数。(默认值:2)
- --run-partition
-
将整个基因组划分为多个分区,并同时在多个分区上运行多个进程,每个分区上运行一个进程。(默认值:None)
- --gpu-num-per-partition GPU_NUM_PER_PARTITION
-
每个分区要使用的 GPU 数量。(默认值:None)
- --max-reads-per-partition MAX_READS_PER_PARTITION
-
在进行采样和重新比对等后续处理之前,每个分区考虑的最大读取数。(默认值:1500)
- --partition-size PARTITION_SIZE
-
在将区域拆分为多个较小的子区域之前,区域中允许的最大碱基对数。(默认值:1000)
- --read-from-tmp-dir
-
运行变异调用器,从 Aligner 和 sort 生成的 bin 文件中读取。并行运行 postsort。此选项将增加设备内存使用量。(默认值:None)
通用选项
- --logfile LOGFILE
-
日志文件的路径。如果未指定,消息将仅写入标准错误输出。(默认值:None)
- --tmp-dir TMP_DIR
-
将存储临时文件的目录的完整路径。
- --with-petagene-dir WITH_PETAGENE_DIR
-
PetaGene 安装目录的完整路径。默认情况下,这应已安装在 /opt/petagene。使用此选项还需要通过设置 LD_PRELOAD 环境变量来预加载 PetaLink 库。可以选择设置用于数据和凭据的 PETASUITE_REFPATH 和 PGCLOUD_CREDPATH 环境变量(默认值:None)
- --keep-tmp
-
完成时不删除存储临时文件的目录。
- --no-seccomp-override
-
不覆盖 docker 的 seccomp 选项(默认值:None)。
- --version
-
查看兼容的软件版本。
GPU 选项
- --num-gpus NUM_GPUS
-
运行要使用的 GPU 数量。将使用 GPU 0..(NUM_GPUS-1)。