用于探索和比较通路资源重叠的Web应用程序
项目描述
一个用于探索、分析和整理通路数据库的集成和可扩展的Web应用程序。ComPath可以在https://compath.scai.fraunhofer.de/公开访问。
此软件包将Bio2BEL通路软件包暴露在包含多个内置可视化和分析工具的Web应用程序中,允许对其进行分析和比较。默认情况下,此软件包包含以下默认软件包
可以通过forkComPath模板存储库添加新的通路/基因签名资源。
引用
如果您在工作中使用了ComPath,请考虑引用
安装

compath 可以通过在您喜欢的终端中运行以下代码轻松从 PyPI 安装
python3 -m pip install compath
或从 GitHub 的最新代码中安装
python3 -m pip install git+https://github.com/bio2bel/compath.git@master
设置
最简单
安装 compath 后,从命令行运行
python3 -m compath populate
此命令将填充默认列表中的所有相关 Bio2BEL 仓库,如果已注册任何可选的 ComPath 仓库条目,也将填充。
对于开发者
如果您只是克隆了仓库并从源代码中安装了它,可以在终端中通过键入 sh load_compath.sh
运行 sh 脚本 load_compath.sh。此脚本将首先安装所有包,然后填充数据库。
如果您已安装包,但尚未加载数据。首先,加载 Bio2BEL HGNC(参见“基因/蛋白质标识符映射”部分)。接下来,使用 python3 -m compath populate
加载所有单个通路数据库包 KEGG、Reactome、WikiPathways 和 MSigDB。此命令假定这些包已安装到您的 Python 环境中。您可以通过在终端中运行 python3 -m compath ls
来检查已安装的包。或者,您可以独立填充每个包:运行 python3 -m bio2bel_kegg populate
、python3 -m bio2bel_reactome populate
、python3 -m bio2bel_wikipathways populate
或 python3 -m bio2bel_msig populate
。
基因/蛋白质标识符映射
为了加载默认包中的基因集,ComPath 假设 Bio2BEL HGNC 已安装并填充。此包是执行多个蛋白质/基因标识符到 HGNC 符号的映射所必需的。需要以下步骤来安装 Bio2BEL HGNC
python3 -m pip install bio2bel_hgnc
python3 -m bio2bel_hgnc populate
运行 Web 应用程序
可以通过以下命令运行应用程序
python3 -m compath web
此命令将在本地运行 Flask 开发服务器,默认端口为 5000(http://localhost:5000)。
整理界面
直接从 ComPath Curation 包中加载通路之间的映射。
python3 -m compath load_mappings --connection="sqlite:////data/bio2bel.db"
从已包含该信息的通路数据库(例如,Reactome)加载分层映射。
python3 -m compath load_hierarchies --connection="sqlite:////data/bio2bel.db"
创建用户。
python3 -m compath manage --connection="sqlite:////data/bio2bel.db" users make_user 'email' 'password'
使用户成为管理员。
python3 -m compath manage --connection="sqlite:////data/bio2bel.db" users make_admin 'email'
Docker 指令
使用 Docker 部署 ComPath
使用 compath 作为名称构建容器。
docker build -t compath:0.0.1 .
创建数据容器,其中将存储数据。
docker create -v /data --name compath-data compath:0.0.1
运行 docker 容器并将其与数据容器连接
docker run --name=compath --volumes-from compath-data --restart=always -d compath:0.0.1
出于管理员目的以及在 Fraunhofer 内部署 ComPath,还可以运行以下命令
sh create_and_build_container.sh
加载数据
将 KEGG、Reactome 和 WikiPathways 模块加载到 ComPath 中。
docker exec -t -it compath /opt/compath/src/bin/load_data.sh
重启容器
重启 compath 容器
docker restart compath
免责声明
ComPath 是一种在学术能力下开发的科学软件,因此不提供任何保修或保证维护、支持或备份数据。