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.3.tar.gz (10.6 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.3-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vcf2fasta-0.1.3.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for vcf2fasta-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a98cf0d95ac1cbbedd706fcb1d770030461eb6ac6c1b7e8f6444519752a93a36
MD5 f5a4f0803bd41fdf7442664e9a96ccb1
BLAKE2b-256 090170f3cf00191a349b79826f32d0b871c82ae4da99e255a2b45743d370dcfb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vcf2fasta-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for vcf2fasta-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f32c3cde05b6ca887c06b6ba99dd78a1c772b997bf8014468b5a4ad6c58b6c8c
MD5 4a4ceaa956c3f1f111de01ea1ce98b50
BLAKE2b-256 f7607a9eeaab1ac6acd9364b62a02dec07825622d49e0b546ea47c45e2156b95

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