REVertant MUTation finder
Project description
.. image:: https://travis-ci.org/inodb/revmut.svg?branch=master
:target: https://travis-ci.org/inodb/revmut
REVertant MUTation finder (REVMUT)
==================================
You have (a) some transcript mutations in HGVS format that change the reading
frame. You want to see if (b) some other transcript mutations in HGVS format
revert the mutations in (a). This script applies the mutations in (a) followed
by the mutations in (b) and shows how the resulting protein changes in length.
Current workflow of finding revertant mutations is:
1. Find putative revertant mutations (SNVs at the same location as original
SNV, indels that restore the reading frame)
2. Run those mutations through Oncotator to get transcript change of putative
revertant mutations in HGVS format
3. Check if one of the transcript change in HGVS format is revertant by looking
how the length of the protein changes
This script helps you to do 3. Steps 1 and 2 might be added at a later stage in
development.
Installation
------------
::
pip install revmut
Run
---
::
usage: revmut [-h] [--version] vcf oncotator_file fasta
Check if a mutation is reverted
positional arguments:
vcf VCF with mutation to be reverted
oncotator_file MAF to find mutations in
fasta Fasta file with transcripts
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
Example
-------
To be reverted mutations like:
- `tests/test_data/to_be_reverted_mutations.txt <tests/test_data/to_be_reverted_mutations.txt>`
Oncotator MAF Putative revertant mutations like:
- `tests/test_data/oncotator.del.maf.txt <tests/test_data/oncotator.del.maf.txt>`
Check if given mutations are in a bam file::
revmut tests/test_data/to_be_reverted_mutations.txt \
tests/test_data/oncotator.del.maf.txt \
tests/test_data/BRCA_transcripts.fa \
2> example/revmut.log
Output:
- `example/revmut.log <example/revmut.log>`_
Developers
----------
Tests
~~~~~
In root dir run::
nosetests
:target: https://travis-ci.org/inodb/revmut
REVertant MUTation finder (REVMUT)
==================================
You have (a) some transcript mutations in HGVS format that change the reading
frame. You want to see if (b) some other transcript mutations in HGVS format
revert the mutations in (a). This script applies the mutations in (a) followed
by the mutations in (b) and shows how the resulting protein changes in length.
Current workflow of finding revertant mutations is:
1. Find putative revertant mutations (SNVs at the same location as original
SNV, indels that restore the reading frame)
2. Run those mutations through Oncotator to get transcript change of putative
revertant mutations in HGVS format
3. Check if one of the transcript change in HGVS format is revertant by looking
how the length of the protein changes
This script helps you to do 3. Steps 1 and 2 might be added at a later stage in
development.
Installation
------------
::
pip install revmut
Run
---
::
usage: revmut [-h] [--version] vcf oncotator_file fasta
Check if a mutation is reverted
positional arguments:
vcf VCF with mutation to be reverted
oncotator_file MAF to find mutations in
fasta Fasta file with transcripts
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
Example
-------
To be reverted mutations like:
- `tests/test_data/to_be_reverted_mutations.txt <tests/test_data/to_be_reverted_mutations.txt>`
Oncotator MAF Putative revertant mutations like:
- `tests/test_data/oncotator.del.maf.txt <tests/test_data/oncotator.del.maf.txt>`
Check if given mutations are in a bam file::
revmut tests/test_data/to_be_reverted_mutations.txt \
tests/test_data/oncotator.del.maf.txt \
tests/test_data/BRCA_transcripts.fa \
2> example/revmut.log
Output:
- `example/revmut.log <example/revmut.log>`_
Developers
----------
Tests
~~~~~
In root dir run::
nosetests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
revmut-0.2.tar.gz
(21.2 kB
view hashes)
Built Distribution
revmut-0.2-py2-none-any.whl
(7.6 kB
view hashes)