Skip to content

rnapdbee/rnapdbee-adapters

Repository files navigation

RNApdbee-adapters

workflow

Description

The project contains adapters for various external tools used by RNApdbee 3.0. It can be divided into three main parts described below.

RNA analysis tools

These tools make RNA structure annotation.

File conversion tools

This tool converts PDB to PDBx/mmCIF and vice versa.

RNA structure in BPSEQ is converted into dot-bracket using an implementation in this library.

RNA visualization tools

These tools make 2D RNA visualization in SVG format.

Installation

Make sure you have Docker installed.

In project root directory type the following command to build the docker image:

DOCKER_BUILDKIT=1 docker build --target server --tag rnapdbee-adapters-image:latest .

Finally create and start docker container:

docker run -p 8000:80 --name rnapdbee-adapters-container --env-file .env rnapdbee-adapters-image:latest

Now API should be available trough:

http://localhost:8000

Usage

Analysis

Use Content-Type: text/plain and send PDB or PDBx/mmCIF with RNA structure (example input). The response will be in json (example output).

$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/analysis-api/v1/barnaba
$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/analysis-api/v1/bpnet
$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/analysis-api/v1/fr3d
$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/analysis-api/v1/maxit
$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/analysis-api/v1/mc-annotate
$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/analysis-api/v1/rnapolis
$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/analysis-api/v1/rnaview

Conversion

Use Content-Type: text/plain and send PDB or PDBx/mmCIF with RNA structure (example input). The response will be in text/plain (example output).

$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/conversion-api/v1/ensure-pdb
$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/conversion-api/v1/ensure-cif

To convert BPSEQ to dot-bracket also use Content-Type: text/plain and send BPSEQ data (example input). The response will be in text/plain (example output).

$ curl -H 'Content-Type: text/plain' --data-binary @/path/to/input http://localhost:8000/conversion-api/v1/bpseq2dbn

Visualization

Use Content-Type: application/json and send 2D model in json (example input). The response will be in image/svg+xml (example output).

$ curl -H 'Content-Type: application/json' --data-binary @/path/to/input http://localhost:8000/visualization-api/v1/pseudoviewer
$ curl -H 'Content-Type: application/json' --data-binary @/path/to/input http://localhost:8000/visualization-api/v1/rchie
$ curl -H 'Content-Type: application/json' --data-binary @/path/to/input http://localhost:8000/visualization-api/v1/rnapuzzler

In case of consensus visualization send multi 2D model (example input).

$ curl -H 'Content-Type: application/json' --data-binary @/path/to/input http://localhost:8000/visualization-api/v1/weblogo

OpenAPI documentation

Documentation can be found here.

Other meaningful software

The following software is used by RNApdbee adapters.

References

  • Bottaro, Sandro, et al. "Barnaba: software for analysis of nucleic acid structures and trajectories." Rna 25.2 (2019): 219-231.
  • Roy, Parthajit, and Dhananjay Bhattacharyya. "Contact networks in RNA: a structural bioinformatics study with a new tool." Journal of Computer-Aided Molecular Design 36.2 (2022): 131-140.
  • Sarver, Michael, et al. "FR3D: finding local and composite recurrent structural motifs in RNA 3D structures." Journal of mathematical biology 56.1 (2008): 215-252.
  • Gendron, Patrick, Sébastien Lemieux, and François Major. "Quantitative analysis of nucleic acid three-dimensional structures." Journal of molecular biology 308.5 (2001): 919-936.
  • Yang, Huanwang, et al. "Tools for the automatic identification and classification of RNA base pairs." Nucleic acids research 31.13 (2003): 3450-3460.
  • Byun, Yanga, and Kyungsook Han. "PseudoViewer3: generating planar drawings of large-scale RNA structures with pseudoknots." Bioinformatics 25.11 (2009): 1435-1437.
  • Tsybulskyi, Volodymyr, Mohamed Mounir, and Irmtraud M. Meyer. "R-chie: A web server and R package for visualizing cis and trans RNA–RNA, RNA–DNA and DNA–DNA interactions." Nucleic Acids Research 48.18 (2020): e105-e105.
  • Wiegreffe, Daniel, et al. "RNApuzzler: efficient outerplanar drawing of RNA-secondary structures." Bioinformatics 35.8 (2019): 1342-1349.
  • Lorenz, Ronny, et al. "ViennaRNA Package 2.0." Algorithms for molecular biology 6.1 (2011): 1-14.
  • Crooks, Gavin E., et al. "WebLogo: a sequence logo generator." Genome research 14.6 (2004): 1188-1190.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •