Skip to main content

Genetic tRNA Adaptation index (gtAI)

Documentation Status

gtAI is a new package implemented in python to effectively estimate the tRNA adaptation index (tAI).

Python Support

Python >=3.7 is required.

Dependencies

  1. Biopython

  2. pandas

  3. numpy

  4. gaft

Installation Instructions

Using pip

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

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:


main_fasta (str): A main fasta file containing the genes to be analyzed.
GtRNA (dict): The tRNA genes count
ref_fasta (str): Reference genes with the highest gene expression in a genome.
genetic_code_number (int): default = 1, The Genetic Codes number described by NCBI (https://www.ncbi.nlm.nih.gov/Taxonomy/Utils/wprintgc.cgi)
size_pop (int): A parameter for the genetic algorithm to identify the population size containing the possible solutions to optimize Sij-values. (default = 60)
generation_number (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.

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 tRNADB_CE() function to get the tRNA gene copy number from tRNADB_CE database using also the link to the tested genome.

In this example, the second option (b) will be used.

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.

genetic_code_number = 1
ref_fasta = ""
bacteria = False
size_pop = 60
generation_number = 100

for more information about gtai_analysis() and the parameters; API documentation.

5- Run gtAI.

df_tai , final_dict_wi, rel_values = Run_gtAI.gtai_analysis(main_fasta,GtRNA,genetic_code_number,bacteria=bacteria, size_pop=size_pop,generation_number=generation_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

6- To save the gtAI result as a CSV file.

import pandas as pd

df_tai.to_csv("test.csv", header=True)

Output example

API Documentation

You can access the API documentation from here: gtAI Documentation

Citation

Metadata

Release files for gtAI 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gtAI 1.0.6
File Size Uploaded
gtAI-1.0.6.tar.gz 18.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gtAI 1.0.6
File Interpreter ABI Platform
gtAI-1.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 34.5 kB

Release files / gtAI-1.0.6.tar.gz

Download URL gtAI-1.0.6.tar.gz
Size 18.1 kB
Tags Source
SHA-256 checksum
How to use checksums
966bd5f84b82b546addf192a8afab613e2606aeb5d8418470ea772fa99511188
BLAKE2b-256 checksum
How to use checksums
c34acd2be870563da06ce8ed77240017892064fc8c0dc578549111c7928abd1f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.1

Release files / gtAI-1.0.6-py3-none-any.whl

Download URL gtAI-1.0.6-py3-none-any.whl
Size 16.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
da1b425ab371469602e924f7a1db5ebb92ad7ac1f300ff11985f54d82c24ae3a
BLAKE2b-256 checksum
How to use checksums
c1f1a41daf169176b3956f089aca0050ac007a6e633c5ef78030218f020f975d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.1

Release history Release notifications | RSS feed

This release

1.0.6 This release

2 release files

1.0.5

2 release files

1.0.4

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page