访问chado数据库的工具
chado-tools的Python项目详细描述
chado工具
python3命令行脚本提供了访问chado数据库的各种工具。
内容
安装
有很多安装chado工具的方法，下面提供了详细信息。如果在安装chado工具时遇到问题，请与本地系统管理员联系。如果遇到错误，请登录here或发送电子邮件至path-help@sanger.ac.uk。
所需依赖项
- python 3.6
- PostgreSQL 9.6或更高版本
来源
从github存储库下载最新版本，或者克隆存储库以获取最新更新。 然后安装软件：
python3 setup.py install
有关运行测试的信息，请参见下面的note。
使用pip
您可以使用命令从Python Package Index (PyPI)安装程序
pip install chado-tools
使用bioconda
该程序也可用作Bioconda package。使用命令安装它
conda install -c bioconda chado-tools
使用Docker容器
该程序也可以作为独立的Docker容器使用。可以使用命令从DockerHub下载最新版本
docker pull sangerpathogens/chado-tools
使用Docker运行容器时，请使用标志--interactive --tty，并使用标志--env映射所有必需的环境变量（见下文）。
用法
安装程序将在您的路径中放置一个名为chado的脚本。
用法是：
chado <command> [<subcommand>] [options]
- 要列出可用的命令和简要说明，只需运行
chado -h或chado --help。 - 要显示程序的版本，请键入
chado -v或chado --version。 - 使用
chado <command> -h或chado <command> --help获取该命令的详细说明和用法。
数据库连接
可以使用环境变量为数据库主机、端口和用户设置默认值。为此，请添加以下内容
指向.bashrc（替换示例值）的行：
export CHADO_HOST=localhost
export CHADO_PORT=5432
export CHADO_USER=chadouser
软件会在系统中查找这些环境变量。如果它们不存在，它将使用 default connection settings，如果您真的需要，可以手动编辑。
类似地，您可以使用环境变量CHADO_PASS指定默认密码。
标志-p强制要求用户输入密码，如果您不想在环境中存储默认密码，则此标志非常有用。
或者，您可以以与default file相同的格式提供自己的yaml配置文件。
带有标志-c（包括密码）。软件将忽略任何环境变量。
可用命令
| Command | Description |
|---|---|
| connect | connect to a CHADO database for an interactive session |
| query | query a CHADO database and export the result into a text file |
| execute | execute a function defined in a CHADO database |
| extract | run a pre-compiled query against the CHADO database |
| insert | insert a new entity of a specified type into the CHADO database |
| delete | delete an entity of a specified type from the CHADO database |
| import | import data from file into the CHADO database |
| export | export data from the CHADO database to file |
| admin | perform admin tasks, such as creating or dumping a CHADO database |
示例
根据当前gmod模式创建名为eukaryotes的新chado数据库：
chado admin create eukaryotes
chado admin setup -s gmod eukaryotes
将此数据库转储到名为eukaryotes.dump：
chado admin dump eukaryotes eukaryotes.dump
列出eukaryotes数据库中的所有有机体：
chado extract organisms eukaryotes
查询数据库以检查某个cvterm_id：
chado query -q "SELECT name FROM cvterm WHERE cvterm_id = 25" eukaryotes
导出包含生物体序列的fasta文件Pfalciparum：
chado export fasta -a Pfalciparum -o Pfalciparum.fasta -t contigs eukaryotes
关于测试的注释
有些集成测试依赖于对postgresql服务器的访问。为了成功运行这些测试，
修改^{a27 }，以便描述现有的
可以连接到的PostgreSQL数据库服务器。然后测试可以作为python3 setup.py test运行。
他们在服务器上创建临时数据库，并在完成后清理这些数据库，因此这不应影响
你在服务器上的任何数据库中存储的任何东西。不过，如果你担心这个，一定要指出
空测试服务器的工具。
许可证
chado tools是免费软件，根据GPLv3授权。
反馈/问题
请向issues page或电子邮件path-help@sanger.ac.uk报告任何问题。
欢迎加入QQ群-->： 979659372
