https://github.com/aliyoussef96/gtai
gtAI is a new package implemented in python to effectively estimate the tRNA adaptation index (tAI).
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 4 DOI reference(s) in README -
✓Academic publication links
Links to: ncbi.nlm.nih.gov, frontiersin.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
gtAI is a new package implemented in python to effectively estimate the tRNA adaptation index (tAI).
Basic Info
Statistics
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
Genetic tRNA Adaptation index (gtAI)
gtAI is a new package implemented in python to effectively estimate the tRNA adaptation index (tAI).
- For more information about the gtAI: https://www.frontiersin.org/articles/10.3389/fmolb.2023.1218518/full
Python Support
Python >=3.7 is required.
Dependencies
Biopython
pandas
numpy
gaft
lxml
Installation Instructions
Using pip
python
pip install gtAI
Contribution Guidelines
Contributions to the software are welcome
For bugs and suggestions, the most effective way is by raising an issue on the github issue tracker. Github allows you to classify your issues so that we know if it is a bug report, feature request or feedback to the authors.
If you wish to contribute some changes to the code then you should submit a pull request How to create a Pull Request? documentation on pull requests
Usage
python
from gtAI import Run_gtAI
df_tai, dict_wi, rel_values = Run_gtAI.gtai_analysis(main_fasta, GtRNA, genetic_code_number, size_pop, generation_number=50, ref_fasta= ref_fasta, bacteria=False)
Where:
```
mainfasta (str): A main fasta file containing the genes to be analyzed. GtRNA (dict): The tRNA genes count reffasta (str): Reference genes with the highest gene expression in a genome. geneticcodenumber (int): default = 1, The Genetic Codes number described by NCBI (https://www.ncbi.nlm.nih.gov/Taxonomy/Utils/wprintgc.cgi) sizepop (int): A parameter for the genetic algorithm to identify the population size containing the possible solutions to optimize Sij-values. (default = 60) generationnumber (int): A parameter for the genetic algorithm to identify the generation number. (default = 100) bacteria (bool): True If the tested organism is prokaryotic or archaeans, else equal to False (default = False)
```
Note: for ref_fasta parameter, the user is able to use a reference set of interest (in fasta format). Otherwise, the package will automatically generate a reference set based on the ENc values of the tested genome. For more information: API documentation.
Note: Population size must be an even number
Returns:
df_tai (dataframe): Contains each gene id and its gtAI value.
final_dict_wi (dict): Contains each codon and its absolute adaptiveness value.
rel_values (dict): Contains each codon and its relative adaptiveness values.
Example
1- Import gtAI functions.
```python
from gtAI import Run_gtAI from gtAI import gtAI ```
2- In this example, we will use Saccharomyces cerevisiae S288C coding sequences.
3- Prepare the tRNA gene copy number of the tested genome.
The user has two options; a) input the tRNA gene copy number as python dictionary or, b) using GtRNAdb() function, the user can get it automatically from the GtRNA database, using the link to the tested genome (In our case Saccharomyces cerevisiae S288C). Or by tRNADBCE() function to get the tRNA gene copy number from tRNADBCE database using also the link to the tested genome.
In this example, the second option (b) will be used.
```python
url_GtRNAdb = "http://gtrnadb.ucsc.edu/genomes/eukaryota/Scere3/"
From GtRNAdb
GtRNA = gtAI.GtRNAdb(url_GtRNAdb)
```
for more infromation about GtRNAdb() as well as tRNADB_CE(); API documentation.
4- Parameter settings for gtai_analysis() function.
```python mainfasta = "SC.fasta" geneticcodenumber = 1 reffasta = "" bacteria = False sizepop = 60 generationnumber = 100
```
for more information about gtai_analysis() and the parameters; API documentation.
5- Run gtAI.
```python dftai , finaldictwi, relvalues = RungtAI.gtaianalysis(mainfasta = mainfasta, GtRNA = GtRNA , reffasta = reffasta, geneticcodenumber = geneticcodenumber, sizepop=sizepop, generationnumber=generationnumber, bacteria=bacteria )
```
Returns:
python
df_tai (dataframe): Contains each gene id and its gtAI value
final_dict_wi (dict): Contains each codon and its absolute adaptiveness value
rel_values (dict): Contains each codon and its relative adaptiveness values
6- To save the gtAI result as a CSV file.
```python import pandas as pd
dftai.tocsv("test.csv", header=True) ```
API Documentation
You can access the API documentation from here: gtAI Documentation
Citation
Anwar, Ali Mostafa, Saif M., Khodary, Eman Ali, Ahmed, Aya, Osama, Shahd, Ezzeldin, Anthony, Tanios, Sebaey, Mahgoub, and Sameh, Magdeldin. "gtAI: an improved species-specific tRNA adaptation index using the genetic algorithm".Frontiers in Molecular Biosciences 10 (2023). https://doi.org/10.3389/fmolb.2023.1218518 https://www.frontiersin.org/articles/10.3389/fmolb.2023.1218518/full
Owner
- Name: Ali Youssef
- Login: AliYoussef96
- Kind: user
- Location: Egypt
- Company: Cairo university
- Website: https://www.linkedin.com/in/ali-youssef-455a92130/
- Repositories: 3
- Profile: https://github.com/AliYoussef96
Trying to be a Bioinformatician
GitHub Events
Total
- Issues event: 1
- Watch event: 4
- Issue comment event: 3
Last Year
- Issues event: 1
- Watch event: 4
- Issue comment event: 3
Committers
Last synced: over 3 years ago
All Time
- Total Commits: 112
- Total Committers: 2
- Avg Commits per committer: 56.0
- Development Distribution Score (DDS): 0.125
Top Committers
| Name | Commits | |
|---|---|---|
| Ali Youssef | a****9@g****m | 98 |
| Saif M. Khodary | 6****f@u****m | 14 |
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 3
- Total pull requests: 0
- Average time to close issues: 13 days
- Average time to close pull requests: N/A
- Total issue authors: 3
- Total pull request authors: 0
- Average comments per issue: 1.33
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- shenweiyan (1)
- zyh4482 (1)
- mpdunne (1)
- SouradiptoC (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 83 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 7
- Total maintainers: 1
pypi.org: gtai
To estimate the tRNA adaptation index (tAI)
- Homepage: https://github.com/AliYoussef96/gtAI
- Documentation: https://gtai.readthedocs.io/
- License: GPLv3
-
Latest release: 1.0.6
published over 2 years ago