Skip to main content

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

Project description

VAFator

PyPI version Run unit tests License

Annotate the variants in a VCF file with allele frequencies, allele counts and depth of coverage for alternate alleles from one or more BAM files.

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.0196078431372549;normal_ac=1;normal_dp=51

Both tumor and normal BAMs are optional, it can annotate only with the tumor BAM and viceversa. If more than one BAM is provided for either the tumor or the normal the frequencies and counts are added up.

Run it as follows:

$ vafator --help
usage: vafator [-h] --input-vcf INPUT_VCF --output-vcf OUTPUT_VCF
               [--normal-bams NORMAL_BAMS [NORMAL_BAMS ...]]
               [--tumor-bams TUMOR_BAMS [TUMOR_BAMS ...]]
               [--mapping-quality MAPPING_QUALITY]
               [--base-call-quality BASE_CALL_QUALITY]

vafator v0.1.0

optional arguments:
  -h, --help            show this help message and exit
  --input-vcf INPUT_VCF
                        The VCF to annotate (default: None)
  --output-vcf OUTPUT_VCF
                        The annotated VCF (default: None)
  --normal-bams NORMAL_BAMS [NORMAL_BAMS ...]
                        Whitespace-separated list of normal BAMs to analyse
                        (default: [])
  --tumor-bams TUMOR_BAMS [TUMOR_BAMS ...]
                        Whitespace-separated list of tumor BAMs to analyse
                        (default: [])
  --mapping-quality MAPPING_QUALITY
                        All reads with a mapping quality lower or equal than
                        this threshold will be filtered out (default: 0)
  --base-call-quality BASE_CALL_QUALITY
                        All bases with a base call quality lower or equal than
                        this threshold will be filtered out (default: 29)

Copyright (c) 2015-2020 TRON gGmbH (See LICENSE for licensing details) 

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-0.3.3.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

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

vafator-0.3.3-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vafator-0.3.3.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for vafator-0.3.3.tar.gz
Algorithm Hash digest
SHA256 7a748e9c5b2790b0a037b41fc9348902e67a8cb62ebf3964e7384edd1b8ae957
MD5 b2255375c0850c60ad5894ca99ae9f9d
BLAKE2b-256 e4ddf7c3ce06d20dbc019bbff93c9b1dafe6be5d8d95ab46b6449e9c2df914d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vafator-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for vafator-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 292e321d653b0da6d4a397fdea6712403ba2c689fafff95d8f52c02701616a14
MD5 e696c3ee2ae704ed3998fbd1c2ffb0b8
BLAKE2b-256 6edaa2c3947a8fc459ad8b6e8e3381f15101720a769e53c881f89294927ce1f0

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