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

Outputs a VCF with the following annotations in the INFO field for tumor and normal:

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

How to install

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

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 is provided for any sample 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.

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/vafator -r 1.1.0 -profile conda --input_files /path/to/your.tsv

where --input_files expects four tab-separated columns without a header:

Sample name VCF Tumor BAMs Normal BAMs
sample_1 /path/to/sample_1.vcf /path/to/sample_1_tumor_1.bam,/path/to/sample_1_tumor_2.bam /path/to/sample_1_normal.bam
sample_2 /path/to/sample_2.vcf /path/to/sample_2_tumor.bam /path/to/sample_1_normal.bam

Optional parameters:

  • --output: the folder where to publish output
  • --skip_multiallelic_filter: skip the filtering of multiallelics by frequency in the tumor (only highest frequency variant at the same position is kept)
  • --base_call_quality: minimum base call quality, reads with values below will be filtered out (default: 30)
  • --mapping_quality: minimum mapping quality, reads with values below will be filtered out (default: 1)

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 equal indel will not be 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.1.0.tar.gz (17.3 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.1.0-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vafator-1.1.0.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for vafator-1.1.0.tar.gz
Algorithm Hash digest
SHA256 af59f054709aeb03164ef8f15df57efd3e24eb1e10230bc9c490d6b5f7067e86
MD5 a6cb2a292ac2a0d64ad9f4c285b7bb4f
BLAKE2b-256 b63e14be0a23ea19300b3ab925f989d1401c6c37c7292d25715b356e09f7be72

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vafator-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for vafator-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e11edd2ac2a322ea90163bbe43bbc96c68aa614f3e09ea7beaaa36262b66e0a
MD5 f7e5c61116c92c5bf7d1a5e88e3bc0d6
BLAKE2b-256 3c30ef1472ba097207bab129cf8f260bcdfa6f29917aaa8dadd59f13bf4c0ce6

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