collectmultiplemetrics
运行 GATK CollectMultipleMetrics 的 GPU 加速版本。
此工具应用 GATK CollectMultipleMetrics 的加速版本,用于评估 BAM 文件指标,例如比对成功率、质量得分分布、GC 偏差和测序伪影。它作为一个“元指标”工具,可以运行 GATK 中可用指标工具的任意组合,以执行对测序运行执行情况的总体评估。可用的指标工具 (PROGRAM) 可以在下面的参考部分找到。
有关所有可用选项的详细列表,请参阅collectmultiplemetrics 参考部分。
# 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 collectmultiplemetrics \
--ref /workdir/${REFERENCE_FILE} \
--bam /workdir/${INPUT_BAM} \
--out-qc-metrics-dir /outputdir/${OUTPUT_DIR}\
--gen-all-metrics
以下命令是 Parabricks 上述命令的 GATK4 对等命令。此命令的输出将与上述命令的输出相同。
$ gatk CollectMultipleMetrics \
--REFERENCE_SEQUENCE <INPUT_DIR>/${REFERENCE_FILE} \
-I <INPUT_DIR>/${INPUT_BAM} \
-O <OUTPUT_DIR>/${OUTPUT_DIR} \
--PROGRAM CollectAlignmentSummaryMetrics \
--PROGRAM CollectInsertSizeMetrics \
--PROGRAM QualityScoreDistribution \
--PROGRAM MeanQualityByCycle \
--PROGRAM CollectBaseDistributionByCycle \
--PROGRAM CollectGcBiasMetrics \
--PROGRAM CollectSequencingArtifactMetrics \
--PROGRAM CollectQualityYieldMetrics
在 BAM 文件上运行 collectmultiplemetrics 以生成多个指标类别的文件。
输入/输出文件选项
- --ref REF
-
参考文件的路径。(默认值:None)
此选项为必填项。
- --bam BAM
-
BAM 文件的路径。(默认值:None)
此选项为必填项。
- --out-qc-metrics-dir OUT_QC_METRICS_DIR
-
用于存储每个分析结果的输出目录。
(默认值:None)
此选项为必填项。
工具选项
- --gen-all-metrics
-
为每个分析生成 QC。(默认值:None)
- --gen-alignment
-
为比对摘要指标生成 QC。(默认值:None)
- --gen-quality-score
-
为质量得分分布指标生成 QC。(默认值:None)
- --gen-insert-size
-
为插入大小指标生成 QC。(默认值:None)
- --gen-mean-quality-by-cycle
-
为每个周期的平均质量指标生成 QC。(默认值:None)
- --gen-base-distribution-by-cycle
-
为每个周期的碱基分布指标生成 QC。(默认值:None)
- --gen-gc-bias
-
用于生成 gc 偏差指标的详细信息和摘要文件的前缀名称。(默认值:None)
- --gen-seq-artifact
-
为测序伪影指标生成 QC。(默认值:None)
- --gen-quality-yield
-
为质量产量指标生成 QC。(默认值:None)
性能选项
- --bam-decompressor-threads BAM_DECOMPRESSOR_THREADS
-
BAM 解压缩的线程数。(默认值:3)
常用选项
- --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)。