rnacentral/r2dt

R2DT

以标准布局可视化RNA二级结构

R2DT软件（RNA 2D Templates）可使用涵盖多种RNA的模板库自动生成RNA二级结构图表，支持的RNA类型包括：

• 来自CRW的5S和SSU rRNA
• 基于3D结构、来自RiboVision的SSU和LSU rRNA
• 来自GtRNAdb的tRNA
• 来自核糖核酸酶P数据库的RNAse P
• 来自Rfam的超过2600个RNA家族

!R2DT方法概述

R2DT被RNAcentral用于可视化超过1400万RNA二级结构。详见方法概述或阅读Nature Communications上的R2DT论文。

示例

以下可视化示例展示了LSU、SSU和5S rRNA，四个tRNA，两个RNAse P，snoRNA，MoCo核糖开关和U4 snRNA。

!R2DT示例

快速开始

R2DT可通过多种方式使用：

• Web应用（由RNAcentral托管）
• API（由EMBL-EBI Web Services提供支持）
• 命令行工具（通过Docker、Singularity或裸金属安装）

安装

!Docker Cloud Build Status

• 从https://hub.docker.com/r/rnacentral/r2dt%E4%B8%8B%E8%BD%BDR2DT%E9%95%9C%E5%83%8F%EF%BC%8C%E9%80%9A%E8%BF%87Docker%E6%88%96Singularity%E8%BF%90%E8%A1%8C%E3%80%82

  Docker

  docker pull rnacentral/r2dt
  docker run --entrypoint r2dt.py rnacentral/r2dt draw --help
  

  Singularity

  singularity build r2dt docker://rnacentral/r2dt    
  singularity exec r2dt r2dt.py draw --help
  

• :hammer_and_wrench: 开发安装：

  # 获取代码
  git clone https://github.com/RNAcentral/R2DT.git
  cd R2DT
  
  # 构建并标记Docker镜像
  docker build -t rnacentral/r2dt .
  docker-compose run cli
  

  当前目录会挂载到容器内，因此所有代码和数据更改会即时反映在容器中。

• :hammer_and_wrench: 裸金属安装：若无法使用容器运行R2DT，请按照Dockerfile中的说明操作。

初始设置

1. 下载预计算数据库（190.1 MB，最后更新于2021年1月7日）并解压。

2. 启动交互式Docker终端会话：

docker run -it -v <path_to_cms>:/rna/r2dt/data/cms -v `pwd`:/rna/r2dt/temp rnacentral/r2dt

• -it - 启动交互式会话
• -v <path_to_cms>:/rna/r2dt/data/cms - 将预计算数据库文件夹<path_to_cms>挂载为容器内的/rna/r2dt/data/cms。:warning: 注意<path_to_cms>必须是完整路径。
• 将当前工作目录挂载为容器内的/rna/r2dt/temp：

  -v `pwd`:/rna/r2dt/temp
  

容器内/rna/r2dt/temp路径下的任何文件在Docker容器退出后均可在主机上访问。

用法

自动模板选择

指定FASTA格式的输入文件（包含一个或多个RNA序列）以及输出文件的创建路径（若文件夹不存在将自动创建）。

r2dt.py draw <input.fasta> <output_folder>

示例：

r2dt.py draw examples/examples.fasta temp/examples

R2DT会自动选择最佳匹配模板并可视化二级结构。

指定模板类别

若预先已知输入序列的RNA类型，可绕过分类步骤以提高性能。

• CRW模板（5S和SSU rRNA）

  r2dt.py crw draw examples/crw-examples.fasta temp/crw-examples
  

• RiboVision LSU和SSU rRNA模板

  r2dt.py ribovision draw_lsu examples/lsu-examples.fasta temp/lsu-examples
  r2dt.py ribovision draw_ssu examples/ribovision-ssu-examples.fasta temp/ssu-examples
  

• Rfam家族

  r2dt.py rfam draw RF00162 examples/RF00162.example.fasta temp/rfam-example
  

• RNAse P

  r2dt.py rnasep draw examples/rnasep.fasta temp/rnasep-example
  

• tRNA（使用GtRNAdb模板）

  # 对于tRNA，若已知域和同型，可提供；否则使用tRNAScan-SE分类
  r2dt.py gtrnadb draw examples/gtrnadb.E_Thr.fasta temp/gtrnadb
  r2dt.py gtrnadb draw examples/gtrnadb.E_Thr.fasta temp/gtrnadb --domain E --isotype Thr
  

手动模板选择

可选择特定模板并完全跳过分类步骤。

1. 获取所有可用模板列表并复制模板ID：

   r2dt.py list-models
   

此外，所有模型均列于文件models.json中。

2. 指定模板（例如RNAseP_a_P_furiosus_JB）：

   r2dt.py draw --force_template <template_id> <input_fasta> <output_folder>
   

   示例：

   r2dt.py draw --force_template RNAseP_a_P_furiosus_JB examples/force/URS0001BC2932_272844.fasta temp/example
   

其他有用命令

• 运行所有测试

  python3 -m unittest
  

• 运行单个测试

  python3 -m unittest tests.tests.TestRibovisionLSU
  

• 使用Ribotyper分类示例序列

  perl /rna/ribovore/ribotyper.pl -i data/cms/crw/modelinfo.txt -f examples/pdb.fasta temp/ribotyper-test
  

• 生成协方差模型和modelinfo文件

  python3 utils/generate_cm_library.py
  r2dt.py generatemodelinfo <协方差模型路径>
  

• 本地预计算模板库（可能需要数小时）：

  r2dt.py setup
  

• 使用Singularity运行R2DT

  singularity exec --bind <path_to_cms>:/rna/r2dt/data/cms r2dt r2dt.py draw sequence.fasta output
  

输出文件

r2dt.py draw会生成名为results的文件夹，包含以下子文件夹：

• svg：SVG格式的RNA二级结构图表
• fasta：输入序列及其点括号表示法的二级结构
• tsv：metadata.tsv文件，列出序列ID、匹配模板和模板来源
• thumbnail：SVG格式的二级结构轮廓缩略图

如何添加新模板

若要提交新模板或替换现有模板，请https://github.com/RNAcentral/R2DT/issues/new%EF%BC%8C%E5%8C%85%E5%90%AB%EF%BC%9A

• 带参考序列和二级结构的FASTA文件 - 见示例
• https://github.com/davidhoksza/traveler#traveler-intermediate-format - 见示例
• 新模板的描述及相关背景信息

可使用generate_cm_library.py脚本，通过上述FASTA和XML文件在本地创建新模板。也可使用XRNA软件的特殊版本https://github.com/LDWLab/XRNA-GT%E7%94%9F%E6%88%90%E6%96%B0%E6%A8%A1%E6%9D%BF%E3%80%82

:warning: GitHub目前不支持附加.fasta或.bpseq扩展名的文件，请将文件附加为.txt格式。

我们将审核模板并尽快在GitHub上回复。

方法概述

R2DT流程包括以下步骤：

1. 生成协方差模型库：使用来自CRW、RiboVision或其他来源的bpseq文件，通过Infernal生成。为获得最佳结果，使用RNAStructure软件的RemovePseudoknots去除二级结构中的假结。
2. 选择最佳匹配协方差模型：使用https://github.com/nawrockie/ribovore%E6%88%96tRNAScan-SE 2.0为每个输入序列选择最佳匹配模型。
3. 折叠序列：使用得分最高的协方差模型将输入序列折叠为与模板兼容的二级结构。
4. 生成二级结构图表：使用https://github.com/davidhoksza/traveler%E5%92%8C%E4%BA%8C%E7%BA%A7%E7%BB%93%E6%9E%84%E5%B8%83%E5%B1%80%E7%94%9F%E6%88%90%E5%9B%BE%E8%A1%A8%E3%80%82

详见R2DT论文。

贡献者

• https://github.com/davidhoksza%EF%BC%88Traveler%E8%BD%AF%E4%BB%B6%EF%BC%89
• https://github.com/nawrockie%EF%BC%88Ribovore%E5%92%8CInfernal%E8%BD%AF%E4%BB%B6%EF%BC%89
• Robin Gutell和Jamie Cannone（CRW）
• Anton S. Petrov、Loren D. Williams及RiboVision团队
• Todd Lowe和Patricia Chan（来自GtRNAdb）
• Blake Sweeney、Carlos Ribas、Fabio Madeira、Rob Finn、Anton I. Petrov（来自EMBL-EBI）

:wave: 我们欢迎更多贡献。请提出issue或提交拉取请求。

致谢

• Sean Eddy - Infernal软件
• David Mathews - RNAstructure软件
• Elena Rivas - R-scape软件
• Zasha Weinberg - R2R软件