ClinVCF generates a VCF file from a ClinVar Full Release (XML format). It was first developped because we observed missing variants in VCF files provided by NCBI. We later extended its capabilities to provived enhanced Clinvar VCF files by :
- Improving Clinvar classification and aggregation method by deciphering "conflicting intepretation" records where almost all submissions goes into the same direction.
- Implementing a more robust gene annotation module based NCBI GFF files.
ClinVCF is developped in NimLang, is highly efficient* (~ 5 minutes to generate the VCF from the XML) and supports GRCh37 and GRCh38 genomes builds.
clinVCF is a part of the Genome Alert! framework - Website https://genomealert.univ-grenoble-alpes.fr/.
You need to have nimlang installed and hts-nim to compile and install clinVCF.
A clean install script of nim and hts-nim is proposed by Brent Pedersen nimlang and hts-nim installed
# Git clone and install
git clone https://github.com/SeqOne/clinvcf.git && cd clinvcf && nimble install
# Download (latest) Clinvar XML release
wget ftp:https://ftp.ncbi.nlm.nih.gov/pub/clinvar/xml/ClinVarFullRelease_00-latest.xml.gz
# Download GFF for gene annotation (GRCh37 or 38)
wget ftp:https://ftp.ncbi.nlm.nih.gov/refseq/H_sapiens/annotation/GRCh37_latest/refseq_identifiers/GRCh37_latest_genomic.gff.gz
wget ftp:https://ftp.ncbi.nlm.nih.gov/refseq/H_sapiens/annotation/GRCh38_latest/refseq_identifiers/GRCh38_latest_genomic.gff.gz
# Generate clinvar VCF
## For GRCh37
clinvcf --coding-first --genome GRCh37 ClinVarFullRelease_00-latest.xml.gz | bgzip -c > clinvar_GRCh37.vcf.gz
## For GRCh38
clinvcf --coding-first --genome GRCh38 ClinVarFullRelease_00-latest.xml.gz | bgzip -c > clinvar_GRCh38.vcf.gz
Usage: clinvcf [options] --genome <version> <clinvar.xml.gz>
Arguments:
--genome <version> Genome assembly to use
Options:
--filename-date Use xml filename date instead of inner date which may differ
--hgnc <table> HGNC table used for gene name alias corrections
Gene annotation:
--gff <file> NCBI GFF to annotate variations with genes
--coding-first Give priority to coding gene in annotation (even if intronic and exonic for another gene)
--gene-padding <int> Padding to annotation upstream/downstream genes (not applied for MT) [default: 5000]
ClinVCF generates a VCF with almost identical format as the original NCBI VCF.
However, not all VCF fields are currently support by ClinVCF (see table bellow), and additionnal fields are provided.
VCF Info field | Status* | Format | Description | Example |
---|---|---|---|---|
ALLELEID | Same | Integer | the ClinVar Allele ID | 1234 |
CLNREVSTAT | Same | String | ClinVar review status for the Variation ID | no_assertion_criteria_provided |
CLNSIG | Same | String | Clinical significance for this single variant | Pathogenic/Likely_Pathogenic |
OLD_CLNSIG | New | String | Orignial Clinical significance if variant reclassified by clinVCF correction module | Conflicting_interpretations_of_pathogenicity |
CLNRECSTAT | New | Integer | 3-levels stars confidence of Variant Alert! automatic reclassfication. | 3 |
GENEINFO | Same | String | Gene(s) for the variant reported as gene symbol:gene id. The gene symbol and id are delimited by a colon (: ) and each pair is delimited by a vertical bar (| ) |
FTCD:10841|FTCD-AS1:100861507 |
MC | Same | String | comma separated list of molecular consequence in the form of Sequence Ontology ID|molecular_consequence |
SO:0001583|missense_variant |
RS | Same | String | dbSNP ID (i.e. rs number) | 80358507 |
Status: Same (identical as in original Clinvar VCF), new (New field from clinVCF)
According to the 1.5 * IQR method, we remove outliers submissions and reclassify conflicting status variants according to ClinVar policies. We apply a 3-level star metrics according to our reclassification confidence. 4 or more submission is needed. We only reclassify variants from conflicting
status to benign
, likely benign
, likely pathogenic
and pathogenic
status.
- ⭐ (1 star) : default
- ⭐⭐ (2 stars) : reclassification remains even if we add a virtual VUS submission
- ⭐⭐⭐ (3 stars) : 2 stars requirements and at least 1 pathogenic (or benign) classification
- We load all genes from the input GFF and add them to the index with a padding (5000bp by default and 2bp for MT genes), to annotate upstream / downstream variants.
- For each variant we query the gene index and retrieve all overlapping genes.
- Overlapped genes are later prioritize in the
GENEINFO
field with two different procedures (depending of clinVCF parameter)- If
--coding-first
option is activated :- We take coding genes over all other genes (except for MT genome)
- If we have an equality we take exonic (+/-20bp padding) over intronic/intergenic candidates
- If none are exonic, we take the gene with closest exon
- If both are exonic, we take the oldest gene ID in NCBI Entrez database
- Default procedure :
- We take coding gene over all other genes (except for MT genome) if the variant is exonic (+/- 20bp)
- If we have an equality we take exonic (+/-20bp padding) over intronic/intergenic candidates
- If none are exonic, we take the gene with closest exon
- If both are exonic, we take the oldest gene ID in NCBI Entrez database
- If
If you use a tool of the Genome Alert! framework, please cite:
Yauy et al., Genome Alert!: a standardized procedure for genomic variant reinterpretation and automated genotype-phenotype reassessment in clinical routine. medRxiv (2021). https://doi.org/10.1101/2021.07.13.21260422
clinVCF is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
clinVCF is a part of the Genome Alert! framework, a collaboration of :