bammetrics
加速的 GATK4 CollectWGSMetrics。
此工具应用了加速版本的 GATK CollectWGSMetrics,用于评估比对的全基因组 BAM 文件的覆盖率和质量。这包括诸如通过碱基和 mapping 质量过滤器的 reads 比例以及基因组范围内的覆盖水平(read-depth)等指标。这些指标可作为用户的整体质量检查,用于评估测序运行的性能。
请参阅 bammetrics 参考 部分,了解所有可用选项的详细列表。
# 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 bammetrics \
--ref /workdir/${REFERENCE_FILE} \
--bam /workdir/${INPUT_BAM} \
--out-metrics-file /outputdir/${METRICS_FILE}
以下命令是上述 Parabricks 命令的 GATK4 对等命令。此命令的输出将与上述命令的输出相同。
$ gatk CollectWgsMetrics \
-R <INPUT_DIR>/${REFERENCE_FILE} \
-I <INPUT_DIR>/${INPUT_BAM} \
-O <OUTPUT_DIR>/${METRICS_FILE}
在 BAM 文件上运行 bammetrics 以生成指标文件。
输入/输出文件选项
- --ref REF
-
参考文件路径。(默认值:None)
此选项为必选项。
- --bam BAM
-
BAM 文件路径。(默认值:None)
此选项为必选项。
- --interval-file INTERVAL_FILE
-
间隔文件路径,格式为以下之一:Picard 样式(.interval_list 或 .picard)、GATK 样式(.list 或 .intervals)或 BED 文件(.bed)。此选项可以多次使用。(默认值:None)
- --out-metrics-file OUT_METRICS_FILE
-
输出指标文件。(默认值:None)
此选项为必选项。
工具选项
- --minimum-base-quality MINIMUM_BASE_QUALITY
-
碱基贡献覆盖率的最低碱基质量。(默认值:20)
- --minimum-mapping-quality MINIMUM_MAPPING_QUALITY
-
read 贡献覆盖率的最低 mapping 质量。(默认值:20)
- --count-unpaired
-
如果为 true,则计数未配对的 reads 和一端未 mapping 的配对 reads。(默认值:None)
- --coverage-cap COVERAGE_CAP
-
将覆盖率超过此值的位置视为具有此值的覆盖率(但计算 PCT_EXC_CAPPED 的差异)。(默认值:250)
- -L INTERVAL, --interval INTERVAL
-
从 BAM/CRAM 文件中收集指标的间隔。所有间隔都将具有 0 的填充以获取 read 记录,并且重叠的间隔将被合并。间隔文件应使用 --interval-file 选项传递。此选项可以多次使用(例如“-L chr1 -L chr2:10000 -L chr3:20000+ -L chr4:10000-20000”)。(默认值:None)
性能选项
- --num-threads NUM_THREADS
-
要运行的线程数。(默认值:12)
常用选项
- --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
-
查看兼容的软件版本。