Skip to main content

Annotate a VCF file with AF, AD and DP from tumor and normal BAMs

Project description

VAFator

DOI PyPI version Anaconda-Server Badge Run unit tests License

VAFator annotates the variants in a VCF file with technical annotations from multiple BAM files. Supports annotating somatic variant calls with the annotations from the normal and the tumor samples; although it can also be used for germline variant calls.

Annotations:

  • Allele frequency (AF): ratio of reads supporting the alternate allele.
  • Allele count (AC): count of reads supporting the alternate allele.
  • Depth of coverage (DP): number of reads covering the position of the variant

How to install

Install from PyPI (pip install vafator) or from bioconda (conda install bioconda::vafator).

When installaing from PyPI there are some system dependencies that will need to be met:

  • libcurl
  • libz
  • liblzma
  • htslib=1.14

How to run

Run as follows:

vafator --input-vcf /path/yo/your.vcf \
--output-vcf /path/yo/your_vafator.vcf \ 
--bam normal /path/to/your_normal.bam \
--bam primary /path/to/your_primary_tumor.bam \
--bam metastasis /path/to/your_metastasis_tumor.bam

This will add annotations for each of the three samples normal, primary and metastasis: normal_ac, normal_dp, normal_af, primary_ac, primary_dp, primary_af, metastasis_ac, metastasis_dp and metastasis_af.

If more than one BAM for the same sample is provided then the annotations are calculated across all BAMs and for also each of them separately (eg: primary_af provides the allele frequency across all primary tumor BAMs, primary_af_1 and primary_af_2 provide the allele frequency on the first and second BAM respectively).

vafator --input-vcf /path/yo/your.vcf \
--output-vcf /path/yo/your_vafator.vcf \ 
--bam primary /path/to/your_primary_tumor_1.bam \
--bam primary /path/to/your_primary_tumor_2.bam

Alternatively, you can use --normal-bams and/or --tumor-bams and the sample names will be predefined to normal and tumorrespectively.

vafator --input-vcf /path/yo/your.vcf \
--output-vcf /path/yo/your_vafator.vcf \ 
--normal-bams /path/to/your_normal.bam \
--tumor-bams /path/to/your_tumor_1.bam,/path/to/your_tumor_2.bam

Use the parameters --mapping-quality and --base-call-quality to define the minimum quality values for each read. All reads with quality values velow these thresholds will be filtered out.

Overlapping reads from read pairs are not double counted. The read with the highest base call quality is chosen.

Understanding the output

The output is a VCF with the some new annotations in the INFO field for the provided sample names. The example below contains vafator annotations for two samples named normal and tumor.

chr1    12345       .       A       G       .       PASS  tumor_af=0.0;tumor_ac=0;tumor_dp=89;normal_af=0.0196;normal_ac=1;normal_dp=51
chr2    12345       .       A       G,T       .       PASS  tumor_af=0.2,0.2;tumor_ac=2,2;tumor_dp=10;normal_af=0.0,0.0;normal_ac=0,0;normal_dp=10

NOTE: notice that VAFator does not annotate samples in the FORMAT field, but in the INFO field

Filter for multi-allelic variants

Multi-allelic variants are those that have more than one alternative allele (e.g.: A>C,G). This tool allows to select the allele with the highest allele frequency and filter out the lower frequency allele.

Run as follows:

multiallelics-filter --input-vcf /path/to/your_vafator.vcf \
--output-vcf /path/to/your_vafator_filtered.vcf \
--tumor-sample-name <SAMPLE> 

The above will look for the annotation <SAMPLE>_af and for multi-allelic variants it will filter out those with lower frequencies. Beware, that if the multi-allelic variants are split into more than one line in the VCF nothing will be filtered out.

Run as a Nextflow pipeline

VAFator is available as a Nextflow pipeline for convenience.

Run as follows:

nextflow run tron-bioinformatics/tronflow-vcf-postprocessing -r 2.2.0 -profile conda ...

See https://github.com/TRON-Bioinformatics/tronflow-vcf-postprocessing for more details

Support for indels

VAFator provides equivalent annotations for indels. Depth of coverage and allele frequency are calculated on the position immediately before the indel. Only insertions and deletions as recorded in the CIGAR matching the respective coordinates and sequence from the VCF file are taken into account. Any read supporting a similar but not identical indel is not counted.

Also, multiallelic mutations are not supported for indels.

Support for MNVs

Not supported

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vafator-1.2.6.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vafator-1.2.6-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file vafator-1.2.6.tar.gz.

File metadata

  • Download URL: vafator-1.2.6.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for vafator-1.2.6.tar.gz
Algorithm Hash digest
SHA256 39a46ebd0ea44d831aaa37b2f5af2b32715a80819fdaca3fbfe37b41d4f048d7
MD5 7750e2f23392c72af56cccc680cda133
BLAKE2b-256 ade6aa6c31313f5f2307342badc1faf5108523a937265c5b5ae9cf7487566203

See more details on using hashes here.

File details

Details for the file vafator-1.2.6-py3-none-any.whl.

File metadata

  • Download URL: vafator-1.2.6-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for vafator-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7e1325e3c2510868d06619122abe16a486ece9fb103ef3a1458ab6ddc9cd9dab
MD5 00661b146ff5c01589813fcd3db4c1c2
BLAKE2b-256 6d6d3e066e945cb9d08b0c65ee469e54e4415fb286028c0df5ce2cd6bacadb77

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page