Skip to main content

A package to convert VCF files to FASTA format.

Project description

vcf2fasta

this package is not actively maintained

Overview

vcf2fasta is a Python package designed to convert genomic regions and intervals into FASTA alignments using VCF files, GFF/GTF files, and a reference FASTA genome. This tool is particularly useful for bioinformaticians and researchers working with genomic data.

Features

  • Convert VCF files to FASTA format.
  • Support for GFF/GTF and BED files for feature annotation.
  • Options to include reference sequences and handle incomplete CDS.
  • Command-line interface for easy usage.

Installation

To install vcf2fasta, you can use pip:

pip install vcf2fasta

Build

Build the package locally with:

python3 -m pip install -e .

Usage

To use vcf2fasta, you can run the command line interface with the required arguments. Here is an example:

vcf2fasta -f genome.fas -v variants.vcf.gz -g intervals.gff -e CDS

Command Line Options

  • -f, --fasta: Path to the reference FASTA file (required).
  • -v, --vcf: Path to the tabix-indexed VCF file (required).
  • -g, --gff: Path to the GFF/GTF file (optional).
  • -b, --blend: Concatenate GFF entries of the specified feature into a single alignment (default: False).
  • -i, --inframe: Force the first codon of the sequence to be inframe (default: False).
  • -o, --out: Name for the output directory (default: "vcf2fasta").
  • -r, --addref: Include the reference sequence in the FASTA alignment (default: False).
  • -s, --skip: Skip features without variants (default: False).

Contribution

Contributions are welcome! If you would like to contribute to vcf2fasta, please fork the repository and submit a pull request. You can also open issues for any bugs or feature requests.

License

This project is licensed under the MIT License. See the LICENSE file for more 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

vcf2fasta-0.1.1.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

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

vcf2fasta-0.1.1-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file vcf2fasta-0.1.1.tar.gz.

File metadata

  • Download URL: vcf2fasta-0.1.1.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/8.7.0 keyring/25.6.0 pkginfo/1.12.1.2 readme-renderer/34.0 requests-toolbelt/1.0.0 requests/2.32.4 rfc3986/1.5.0 tqdm/4.67.1 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for vcf2fasta-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cf40dfea98411eaa81011e3b58794f6220cf81e11d5cf59fd10e3a405e404636
MD5 a1e27e8e0b2058335ee7ca6046256ad8
BLAKE2b-256 9483e454dd4e8cff20a6e7a37d364c6971750ce43a3f56c6701614999c12e557

See more details on using hashes here.

File details

Details for the file vcf2fasta-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: vcf2fasta-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/8.7.0 keyring/25.6.0 pkginfo/1.12.1.2 readme-renderer/34.0 requests-toolbelt/1.0.0 requests/2.32.4 rfc3986/1.5.0 tqdm/4.67.1 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for vcf2fasta-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a2b28cddbd3208dd5e87731fcd7e7932d385b8271aa11a62f1d628307530e2e
MD5 41e288f7c257b30abc21e197099413b3
BLAKE2b-256 8c0f77ce8cc63d16bff71b0fb42f736cd45a789010f301d1232315676b6c3b72

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