Skip to main content

Open Source Transcription Initiation Rates

Project description

OSTIR

Open Source Translation Initiation Rates

OSTIR (Open Source Translation Initiation Rates) is a Python package for predicting the rates at which ribosomes will bind to and initiate translation from different start codons in bacterial mRNAs. It uses the ViennaRNA software suite to perform the necessary free energy calculations. The code builds on the last open source version of the RBS calculator that implements the calculations described in Salis 2009.

OSTIR includes several improvements in usability. It supports multi-FASTA input with command line parameters or CSV input that can define parameters on a per-sequence basis. Additionally, OSTIR supports multi-threaded execution, accelerating use cases that require the analysis of very large sequences.

Installation

From Conda:

  • Run conda install --bioconda ostir

From Pip:

  • Download and install ViennaRNA, following the instructions here.
  • Run pip install ostir

From Source:

  • Clone this repository
  • Navigate to the ./ostir/ directory
  • Install/update the necessary packaging tools with python3 -m pip install --user --upgrade setuptools wheel
  • Package the code with python3 setup.py sdist bdist_wheel
  • Install the package with python3 -m pip install ./
  • Download and install ViennaRNA, following the instructions here.
  • To test your install run python -m unittest

Usage

OSTIR can be executed via the included command-line script, ostir.

usage: ostir [-h] -i str/filepath [-o filepath] [-v] [-s int] [-e int] [-a str] [-p] [-q] [-j int] [-t [string|csv|fasta]]

Open Source Transcription Initiation Rates

optional arguments:
  -h, --help            show this help message and exit
  -i str/filepath, --input str/filepath
                        Input filename (FASTA/CSV) or DNA/RNA sequence. For CSV input files, there must be a 'seq' or 'sequence'
                        column. Other columns will override any options provided at the command line if they are present:
                        'name/id', 'start', 'end', 'anti-Shine-Dalgarno'.
  -o filepath, --output filepath
                        Output file path. If not provided, results will output to the console.
  -v, --verbose         Prints verbose output.
  -s int, --start int   Most 5' position to consider a start codon beginning.
  -e int, --end int     Most 3' position to consider a start codon beginning
  -a str, --anti-Shine-Dalgarno str
                        anti-Shine-Dalgarno sequence: the 9 bases located at the 3' end of 16S rRNA. May be provided as DNA or
                        RNA. Defaults to that of E. coli (ACCTCCTTA).
  -p, --print-sequence  Include the input mRNA sequence in output CSV files
  -q, --print-anti-Shine-Dalgarno
                        Include the anti-Shine-Dalgarno sequence in output CSV files
  -j int, --threads int
                        Number of threads for multiprocessing
  -t [string|csv|fasta], --type [string|csv|fasta]
                        Input type (overrides autodetection)

OSTIR can also be called from within a user's Python script via the run_ostir function. This function returns a list of the translation initiation rates (expression levels) predicted for each start codon in the sequence.

Example usage:

from ostir.ostir import run_ostir

seq = "ACUUCUAAUUUAUUCUAUUUAUUCGCGGAUAUGCAUAGGAGUGCUUCGAUGUCAU"
results = run_ostir(seq, name="my_sequence", aSD="ACCTCCTTA", threads=8)
print(results)

results = run_ostir(seq, start=31, end=31, aSD="ACCCCCTTA", verbose=True)
print(results)

Arguments:

  • seq: mRNA sequence to search for translation initiation sites (REQUIRED)
  • start: Most 5' position to consider a start codon beginning (1-indexed)
  • end: "Most 3' position to consider a start codon beginning (1-indexed)"
  • name: Name or id of the sequence to include in output.
  • aSD: anti-Shine-Dalgarno sequence. Defaults to that of E. coli.
  • threads: Number of parallel processes to launch during prediction.
  • verbose: Prints debug information

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

OSTIR-1.0.0.tar.gz (160.8 kB view details)

Uploaded Source

Built Distribution

OSTIR-1.0.0-py3-none-any.whl (112.8 kB view details)

Uploaded Python 3

File details

Details for the file OSTIR-1.0.0.tar.gz.

File metadata

  • Download URL: OSTIR-1.0.0.tar.gz
  • Upload date:
  • Size: 160.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for OSTIR-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9917d348d80b940f937b38816c34d75070ec486fccaf2c40067a891e9789ce4d
MD5 dada753c83772be8b1da5c9d4c4b2ed5
BLAKE2b-256 bcbdb000f636029e6d21a6837b8f69c30ecc08fc7303a62c9264eefc4a1a0f28

See more details on using hashes here.

Provenance

File details

Details for the file OSTIR-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: OSTIR-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 112.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for OSTIR-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0491a7dec8ddea46a81b84b5929a4a2dfa5c275c1b8426c6ce6503d5f0137af
MD5 fc060beb2ee520368758237191e28d1a
BLAKE2b-256 61604fd3bd5ce66e03ba5032d9e53dedf498581a83b454906bc16182be692c24

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page