Variant annotator for MToolBox.
Project description
mtoolnote
Variant annotator for MToolBox.
Free software: MIT license
GitHub repo: https://github.com/mitoNGS/mtoolnote
Features
mtoolnote can annotate mitochondrial variants from:
human genomes, using data stored in a local database derived from HmtVar;
non-human genomes, using data from BioMart.
Currently, only the following species are supported: oaries, ptroglodytes, scerevisiae, ecaballus, fcatus, cfamiliaris, pabelii, ggallus, mmulatta, rnorvegicus, btaurus, oanatinus, sscrofa, nleucogenys, chircus, mmusculus, tguttata, tnigroviridis, mgallopavo, mdomestica, drerio
Usage
Once installed, mtoolnote offers a CLI command and a Python function to annotate both human and non-human VCF files.
Human mitochondrial variant annotation
Using the CLI:
$ mtoolnote INPUT_VCF OUTPUT_VCF
where INPUT_VCF and OUTPUT_VCF represent file paths. Use the --csv flag option to create an annotated CSV file in addition to the VCF output.
Using the Python module:
import mtoolnote mtoolnote.annotate("input.vcf", "output.vcf")
Use the csv=True option to create an annotated CSV file in addition to the VCF output.
Non-human mitochondrial variant annotation
Using the CLI:
$ mtoolnote INPUT_VCF OUTPUT_VCF SPECIES
where SPECIES indicates the sample species, one of oaries, ptroglodytes, scerevisiae, ecaballus, fcatus, cfamiliaris, pabelii, ggallus, mmulatta, rnorvegicus, btaurus, oanatinus, sscrofa, nleucogenys, chircus, mmusculus, tguttata, tnigroviridis, mgallopavo, mdomestica, drerio. Use the --csv flag option to create an annotated CSV file in addition to the VCF output.
Using the Python module:
import mtoolnote mtoolnote.annotate("input.vcf", "output_vcf", "species")
Use the csv=True option to create an annotated CSV file in addition to the VCF output.
Installation
After cloning this repo, cd in it and install mtoolnote using:
$ python setup.py install # in case this does not work: $ pip install -r requirements.txt $ pip install .
or in development mode:
$ pip install -r requirements_dev.txt $ pip install -e .
Testing
After installation, run all tests with:
$ pytest
or the full suite (tests using python3.6, python3.7, flake8) with:
$ tox
Credits
This package was created with Cookiecutter and the cc-pypackage project template.
History
0.1.0 (2019-08-27)
First development release.
0.1.1 (2019-09-02)
Add option to create csv from annotated vcf file.
0.1.2 (2019-09-17)
Fix requirements;
Relocate local database for human annotation.
0.1.3 (2019-09-25)
Add multi-threading processing for non-human annotations (fix #1).
0.1.4 (2019-11-30)
Add haplogroup-specific allele frequencies to final annotations (fix #4);
Add external predictors to final annotations (fix #5).
0.1.5 (2020-02-09)
Add locus name to basic information even for non-annotated human variants (fix #14);
Update requirements (fix #17);
Restructure code.
0.1.6 (2020-03-04)
Use the Loci table to provide basic locus annotations (fix #22).
0.1.7 (2020-04-04)
Add functional locus annotations using the FuncLoci table (fix #24).
0.2.0 (2020-04-08)
Add options to choose specific annotations to include in human data (fix #28).
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
File details
Details for the file mtoolnote-0.2.0.tar.gz
.
File metadata
- Download URL: mtoolnote-0.2.0.tar.gz
- Upload date:
- Size: 7.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8571baa0ec556803ba7d66e9957c61fc14779e9cdca7236b96f9659336f55c20 |
|
MD5 | e748ae06120e5339a4c1012efaca529a |
|
BLAKE2b-256 | 86926437aad413d062ed6962efaa08f713c76626f9e9079827cacbedbb9740cc |
File details
Details for the file mtoolnote-0.2.0-py2.py3-none-any.whl
.
File metadata
- Download URL: mtoolnote-0.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.9 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7429f55e981a2034d02ac1c3fcf5e250fa53a15c81468eb2430ab713e82df81 |
|
MD5 | 23f1394768f730f3696e88dc877bf3a6 |
|
BLAKE2b-256 | 3a1c0c96a9e493e741ab2f973a5bc065f82f002ecefd345c82f73bb2d348401c |