SKILL.md
gnomAD Database
Prerequisites
uv: Read theuvskill and follow its Setup instructions to ensureuvis installed and on PATH.- User Notification: If .licenses/gnomad_database_LICENSE.txt does not already exist in the workspace root directory then (1) prominently notify the user to check the terms at https://gnomad.broadinstitute.org/policies and https://gnomad.broadinstitute.org/data#api, then (2) create the file recording the notification text and timestamp.
Core Rules
- Use the Wrapper: ALWAYS execute the provided helper scripts to query the database rather than accessing the database directly. The scripts automatically enforce the gnomAD API rate limits gracefully.
- Notification: If this skill is used, ensure this is mentioned in the output.
Utility Scripts
All scripts are located in the scripts/ subdirectory of this skill's
installation directory. When running them, use the full absolute path to the
script (e.g. /path/to/gnomad_database/scripts/get_variant_frequency.py).
1. Variant Frequency. Retrieves global and ancestry-specific allele
frequencies, homozygote counts, and Grpmax Filtering AF (faf95/faf99) for
exome, genome, and total (exome+genome combined) data. The filtering allele
frequency (FAF) is the maximum credible genetic ancestry group AF (lower bound
of the 95% or 99% CI). Variant ID format must be chrom-pos-ref-alt (e.g.,
1-55516888-G-GA). Alternately, you may provide an rsID.
# By variant ID:
uv run scripts/get_variant_frequency.py --variant_id {variant_id} [--dataset {dataset}] --output variant_frequency.json
# By rsID (e.g., rs1800562):
uv run scripts/get_variant_frequency.py --rsid {rsid} [--dataset {dataset}] --output variant_frequency.json
2. Gene Constraint. Retrieves constraint metrics for a gene. The response will explicitly contain , and the LOEUF score is represented by .
