A package for computing variation numbers
Project description
Variation Number
A package for calculating the variation number of nucleotide/protein sequence using sequence orthologs.
Characteristic Attribute Organization System (CAOS) discovers rules associated with a given phylogenetic tree. A pure (Pu) rule or character attribute (CA) is a state that exists in all elements of a clade but not the alternate clade; a private (Pr) CA is present in some members of a clade but absent in the alternate clade. A variation number (VN) is defined as the number of occurrences of a position as a CA in all the tree clades.
The method is described in the publication:
Lai, J., & Sarkar, I. N. (2021). A Phylogenetic Approach to Analyze the Conservativeness of BRCA1 and BRCA2 Mutations. AMIA ... Annual Symposium proceedings. AMIA Symposium, 2020, 677–686. https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8075528/
Features
- Download orthologs
- Build phylogenetic trees
- Generate variation numbers
Required python packages
Python packages (most of which can be installed using pip) needed to run LYRUS include:
- skbio(0.5.6): http://scikit-bio.org
- numpy(1.22.3): https://numpy.org/install/
- Bio(1.79): https://biopython.org/wiki/Download
- BeautifulSoup(4.10.0): https://www.crummy.com/software/BeautifulSoup/bs4/doc/#installing-beautiful-soup
Required external packages
In order to run vn.py, please install command line version for:
- Clustal Omega: http://www.clustal.org/omega/
- Mafft: https://mafft.cbrc.jp/alignment/software/
- PAUP: http://phylosolutions.com/paup-test/
Running instructions for installation using pip
variation_number(0.2.2) is published on PyPI. Use the following command to install variation_number using pip:
$ pip install variation-number
Usage
import variation_number as vn
import os
gene = 'BRCA1'
seqtype =' protein'
outputDir = '{}/output'.format(os.getcwd())
# Download orthologs from NCBI orthologs database (optional; can use user provided sequence file)
acc = vn.getFasta(gene, outputDir,seqtype,refseqID=None)
# Calculate variation number using clustal omega
vn.processVN(file='{}/{}'.format(outputDir, gene), outputDir, accession_full=acc, seqType=seqtype, aligned=False, alignTool='clustal')
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
Built Distribution
Hashes for variation_number-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37559ab79b6395b7ffe81b3ed49ec2d2a0a82fc1f63f072401085f189cd3a6fa |
|
MD5 | aba08ddbdb142b8ab24f94801a6e6a27 |
|
BLAKE2b-256 | e3e35cc7815ccf924d15af8f321ba9aa2a1749652dfade802f8d7d84441514b0 |