探索和比较路径资源重叠的web应用程序
compath的Python项目详细描述
一个集成的、可扩展的web应用程序,用于探索、分析和管理路径数据库。ComPath在https://compath.scai.fraunhofer.de/上公开提供
这个包将Bio2BEL路径包公开到包含多个内置可视化和 分析工具允许他们的分析和比较默认情况下,此包包装以下默认值 套餐:
新的途径/基因签名资源可以通过分叉ComPath Template Repository来添加。
引文
如果你在工作中使用compath,请引用[1]:
[1] | Domingo-Fernández, D., et al. (2019). ComPath: An ecosystem for exploring, analyzing, and curating mappings across pathway databases. npj Syst Biol Appl., 5(1):3. |
安装
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 存储库已经注册了入口点,也将被填充
对于开发者
如果您刚刚克隆了repo并从源代码中安装了它,那么可以通过以下方式运行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
固化界面
直接从ComPath Curation包加载路径之间的映射。
python3 -m compath load_mappings --connection="sqlite:////data/bio2bel.db"
从已经包含该信息的路径数据库加载层次映射(例如,reactiome)
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指令
部署Compath with Docker
- 使用compath作为名称构建容器。
docker build -t compath:0.0.1 .
- 创建数据所在的数据容器
docker create -v /data --name compath-data compath:0.0.1
- 运行Docker Container并将其与数据容器连接
docker run --name=compath --volumes-from compath-data --restart=always -d compath:0.0.1
For admin purposes and deploying ComPath inside Fraunhofer you can also run the following command
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