assess_match_qc
Assess how well polygenic scores matched a target genotype dataset in pgsc_calc by reporting variant match rate, weight coverage, strand handling, exclusions, and per-chromosome coverage for a single score or whole run.
Instructions
Assess how well polygenic scores matched a target genotype dataset in pgsc_calc.
Works for a single score or a whole run. Returns raw metrics (variant match rate, weight coverage, strand handling, exclusions, per-chromosome coverage), structural warnings and descriptive observations. Large runs return a compact index of every score; request specific pgs_ids for full detail. Interpret with the guide at pgs://guides/match-qc.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pgs_ids | No | Optional PGS IDs (e.g. PGS000004) or full accessions to report on. Omit for every score in the file. | |
| log_path | No | Optional path to the variant-level match log, e.g. `{sampleset}_log.csv.gz`. Enables weight, chromosome, indel and match-type metrics. The first read of a large log takes about a minute per few GB; it is then cached. | |
| summary_path | Yes | Path to the pgsc_calc match summary, e.g. `{sampleset}_summary.csv`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scores | Yes | Full detail for selected scores. | |
| dataset | Yes | ||
| log_used | Yes | ||
| n_scores | Yes | ||
| warnings | Yes | ||
| chromosomes | Yes | Run-wide coverage over score-variant pairs; a shared variant counts per score. Null without a log, or when specific scores were requested. | |
| detail_note | No | Set when detail was limited; explains how to get more. | |
| score_index | Yes | ||
| genome_builds | Yes | ||
| n_pipeline_fail | Yes | ||
| n_pipeline_pass | Yes | ||
| inferred_settings | Yes |