README

Tripal JBrowse 集成

此模块集成了 GMOD JBrowse 到您的 Tripal 网站，提供以下功能：

通过 Tripal JBrowse 页面 集成到 Tripal 页面，
即将推出：通过 Tripal JBrowse 管理 创建和管理 JBrowse 实例的用户界面。

这种强大的组合允许您以管理员友好的方式为用户提供无缝的基因组浏览。

安装说明

使用 Docker 快速开始

如果您还没有 Tripal 4 网站，并想尝试我们的模块，您可以使用 Tripal Docker。通过使用此存储库中的 Dockerfile，您将模拟一个已经启用 Tripal JBrowse 的 Tripal 4 网站。您只需要在本地机器上安装 Docker 或 Docker Desktop！

克隆此存储库并进入它

git clone https://github.com/tripal/tripal_jbrowse.git
cd tripal_jbrowse

构建 docker 镜像（这可能需要几分钟）

docker build . --tag=tripal_jbrowse:latest

运行您刚刚构建的镜像上的 docker 容器。此运行命令将您的当前目录（即此存储库）映射到容器中，因此您可以在本地编辑存储库（如果您想为此模块做出贡献，这特别有用！）。您也可以根据需要更改端口 80 到另一个端口（例如：9000:80）。

docker run -dit --name=tripaljbrowse --publish=80:80 --volume=`pwd`:/var/www/drupal/web/modules/contrib/tripal_jbrowse tripal_jbrowse:latest

重新启动 docker 容器的 postgresql 数据库

docker exec tripaljbrowse service postgresql restart

现在您可以通过 https:/// 浏览到您的 Tripal JBrowse docker 并运行！注意：如果您在步骤 3 中更改了端口号，您将导航到 localhost:<端口号>（例如：https://:9000）。

从这里开始，如果您想了解如何嵌入示例 JBrowse 的教程，请参阅此处： Tutorial.md

如果您想为此模块的开发做出贡献，请参阅下面的贡献部分。

如果您已经有一个现有的 Tripal 4 网站

导航到您网站的根目录（在 Tripal Docker 中称为“drupal” - 您需要在通过命令行首次进入 docker 之后使用 cd ../ 来到达那里）。然后运行： composer require tripal/tripal_jbrowse

现在您可以通过导航到 管理 » 管理 » 扩展 并滚动到“Tripal JBrowse”标题来启用模块。点击“Tripal JBrowse”旁边的复选框（现在忽略 Tripal JBrowse 管理），滚动到底部并点击“安装”。

恭喜，您现在已安装 Tripal JBrowse！

目前，您不需要在您的 Tripal 4 网站所在的同一台机器上安装 JBrowse2。相反，模块使用指向外部配置文件的 URL 来嵌入该实例。目前有计划支持访问本地托管的 JBrowse2 实例，就像此模块的 7.x-3.x 版本所做的那样。

实例列表和创建

要列出所有实例，请访问 管理 » Tripal » 内容 » JBrowse 实例

另一个到达那里的方法是 管理 » 管理 » 内容 » JBrowse 实例

您可以从这个页面创建一个新的 JBrowse 实例（使用“+ 添加 jbrowse 实例”按钮）。请注意，您的 Tripal 网站需要已经创建一个生物体和基因组组装，以便将其与您的 JBrowse 实例关联。这两者都可以通过 管理 » 管理 » 内容 » Tripal 内容 并点击 + 添加 Tripal 内容 来创建。

编辑或删除实例

在 JBrowse 实例列表中，您可以通过在“操作”下的下拉菜单中选择“编辑”或“删除”来编辑或删除现有的 JBrowse 实例。

您也可以从实例页面本身执行这些操作，通过选择页面顶部的“查看”标签旁边的“编辑”或“删除”标签。

使用 tripal_jbrowse docker 贡献开发

请参考 使用 Docker 快速入门 中的上述步骤来设置用于开发的 docker 容器。有关如何登录和管理站点以及任何故障排除的信息，请参阅 Tripal Docker 文档。

此设置允许您在您最喜欢的编辑器中本地打开存储库文件，您所做的任何更改都应显示在 https:// 上。您还可以随时设置一个新的 docker 容器，其中包含对存储库的现有代码更改（如果您需要快速重置任何配置更改或添加到您的 Tripal 4 网站的内容很有用）。

如果您看不到对代码所做的更改，请尝试在网站上运行缓存重建

docker exec tripaljbrowse drush cr

许可证 & 致谢

此模块是开源的，并使用 GPLv3 许可。阅读完整许可证。

4.x 作者

Carolyn Caron (@carolyncaron)
Lacey-Anne Sanderson (@laceysanderson)

7.x-3.x 作者

Lacey-Anne Sanderson (@laceysanderson)
Abdullah Almsaeed (@almasaeed2010)
Joe West (@jwest60)
其他贡献者 (https://github.com/tripal/tripal_jbrowse/graphs/contributors)

版权 2018 萨斯喀彻温大学和田纳西大学诺克斯维尔分校。

引用

Lacey-Anne Sanderson, Abdullah Almsaeed, Joe West, & Yichao Shen. (2019). tripal/tripal_jbrowse: Tripal JBrowse 3.0 (Version 7.x-3.0). Zenodo. http://doi.org/10.5281/zenodo.3564724.

tripal / tripal_jbrowse

维护者

详细信息