qc-metric-aggregator

从基因组数据的QC结果目录中解析出单个指标，并输出包含所需指标和样本总体PASS/FAIL状态的报告。

安装

pip install qc-metric-aggregator

用法

usage: aggregate-qc-metrics [-h]
                            sample_name metrics_dir output_file threshold_file

positional arguments:
  sample_name     The sample name or id for which the QC metrics apply
  metrics_dir     The directory to search for metric files, often a cromwell
                  run directory
  output_file     File path to store the finalized mertrics TSV
  threshold_file  Path to the yml thresholds file to validate against

optional arguments:
  -h, --help      show this help message and exit

示例调用

aggregate-qc-metrics HG00096 /opt/qc/results/HG00096/WholeGenomeSingleSampleQc /opt/qc/scores/qc_results.tsv thresholds.yml

输出格式

即将推出...

阈值文件

您需要传入一个包含您感兴趣指标通过/失败阈值的YAML文件。文件格式由一系列对象组成，每个对象包含以下键

示例可以在此处找到

支持的指标

添加其他指标

要支持其他指标，您只需继承Metric并在AvailableMetrics中注册即可。

由于许多质量控制指标以TSV格式输出，因此有一个辅助类TSVMetric，您可以在继承Metric的同时从中继承，这将使这更容易。所有目前支持的指标都使用此辅助类，因此您应该可以参考它们作为示例。