biomadeira / auto-traveler

Visualise RNA secondary structure using standard layouts

Home Page:https://rnacentral.org/search?q=has_secondary_structure:%22True%22

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Auto Traveler

Auto Traveler automatically generates RNA secondary structure in standard layouts using templates from the following sources:

RNAcentral uses Auto Traveler to visualise RNA secondary structures. For more details see RNAcentral help or browse all secondary structures.

Method overview

  1. Generate a library of covariance models using bpseq files from CRW, RiboVision or another source with Infernal. For best results, remove pseudoknots from the secondary structures using RemovePseudoknots from the RNAStructure package.
  2. Select the best matching covariance model for each input sequence using Ribotyper.
  3. Fold input sequence into a secondary structure compatible with the template using the top scoring covariance model.
  4. Generate secondary structure diagrams using Traveler and the secondary structure layouts.

Installation

Docker Cloud Build Status

Pull from Docker Hub:

docker pull rnacentral/auto-traveler

or build your own Docker image:

# Get the code:
git clone https://github.com/RNAcentral/auto-traveler.git
cd auto-traveler

# Build and tag a Docker image:
docker build -t rnacentral/auto-traveler .

Usage

Run Docker container and mount the current directory inside the container:

docker run -it -v `pwd`:/rna/auto-traveler rnacentral/auto-traveler

Perform one-time initial setup:

cd auto-traveler
auto-traveler.py setup

# run tests to verify that the installation worked
python3 -m unittest

Run examples:

python3 auto-traveler.py draw examples/examples.fasta temp/examples

For performance reasons you can run the following commands:

auto-traveler.py crw draw examples/crw-examples.fasta temp/crw-examples
auto-traveler.py ribovision draw examples/lsu-examples.fasta temp/lsu-examples
auto-traveler.py rfam draw RF00162 examples/RF00162.example.fasta temp/rfam-example

Additional commands:

# classify example sequences using Ribotyper
perl ribotyper.pl -i data/cms/all.modelinfo.txt -f examples/pdb.fasta example-output

# to generate covariance models:
python3 utils/generate_cm_library.py
python3 utils/generate_lsu_cm_library.py

python3 utils/generate_model_info.py
python3 utils/generate_model_info.py --cm-library=data/ribovision/cms --rna-type=LSU

Acknowledgements

About

Visualise RNA secondary structure using standard layouts

https://rnacentral.org/search?q=has_secondary_structure:%22True%22

License:Apache License 2.0


Languages

Language:PostScript 99.9%Language:Python 0.1%Language:Dockerfile 0.0%