A package to convert VCF files to FASTA format.
Project description
vcf2fasta
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
Make sure you have the required dependencies installed, including pysam and art. You can install them using:
pip install pysam art
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vcf2fasta-0.1.0.tar.gz.
File metadata
- Download URL: vcf2fasta-0.1.0.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
daf53f6339ba921ccea9b81b6c7ca1779eda0bc30244b7652d781497640b1381
|
|
| MD5 |
c57b615a27d3cf4b275c78b2fe255fc0
|
|
| BLAKE2b-256 |
4aa52db811f136f3425c6685e9e9f0df850b475b9efa99a0dd7116e32b43b847
|
File details
Details for the file vcf2fasta-0.1.0-py3-none-any.whl.
File metadata
- Download URL: vcf2fasta-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eb374ed6b2f377e76f378e90059b4e02eebfceac08b8f4001ead778691b95eba
|
|
| MD5 |
677b6af2aceefdfb191459defe9e5c58
|
|
| BLAKE2b-256 |
a08f29800b1cee5e6356973c6e3f99e81f847bd777926d22609c09cb63938ad8
|