PyCTD is a Python package to access and query chemical–gene/protein interactions, chemical–disease and gene–disease relationships by data provided by the Comparative Toxicogenomics Database . Data are installed in a (local or remte) RDBMS enabling bioinformatic algorithms very fast response times to sophisticated queries and high flexibility by using SOLAlchemy database layer. PyCTD is developed by the Department of Bioinformatics at the Fraunhofer Institute for Algorithms and Scientific Computing SCAI For more in for information about CTD go to this section in the documentation.
This development is supported by following IMI projects:
PyCTD uses SQLAlchemy to cover a wide spectrum of RDMSs (Relational database management system). For best performance MySQL or MariaDB is recommended. But if you have no possibility to install software on your system SQLite - which needs no further installation - also works. Following RDMSs are supported (by SQLAlchemy):
- Firebird
- Microsoft SQL Server
- MySQL / MariaDB
- Oracle
- PostgreSQL
- SQLite
- Sybase
This is a quick start tutorial for impatient.
PyCTD can be installed with pip.
pip install pyctdIf you fail because you have no rights to install use superuser (sudo on Linux before the commend) or ...
pip install --user pyctdIf you want to make sure you are installing this under python3 use ...
python3 -m pip install pyctdNote
If you want to use SQLite as your database system, because you ...
- have no possibility to use RDMSs like MySQL/MariaDB
- just test pyctd, but don't want to spend time in setting up a database
skip the next MySQL/MariaDB setup section. But in general we recommend MySQL or MariaDB as your RDBMS.
If you don't know what all that means skip the section MySQL/MariaDB setup.
Don't worry! You can always later change the configuration. For more information about changing database system later go to the subtitle Changing database configuration Changing database configuration in the documentation on readthedocs.
Log in MySQL as root user and create a new database, create a user, assign the rights and flush privileges.
CREATE DATABASE pyctd CHARACTER SET utf8 COLLATE utf8_general_ci;
GRANT ALL PRIVILEGES ON pyctd.* TO 'pyctd_user'@'%' IDENTIFIED BY 'pyctd_passwd';
FLUSH PRIVILEGES;Start a python shell and set the MySQL configuration. If you have not changed anything in the SQL statements ...
import pyctd
pyctd.set_mysql_connection()If you have used you own settings, please adapt the following command to you requirements.
import pyctd
pyctd.set_mysql_connection()
pyctd.set_mysql_connection(host='localhost', user='pyctd_user', passwd='pyctd_passwd', db='pyctd')The updating process will download the files provided by the CTD team on the download page
Warning
Please note that download files needs 1,5Gb of disk space and the update takes ~2h (depending on your system)
import pyctd
pyctd.update()>>> query = pyctd.query()
>>> results =query.get_chem_gene_interaction_actions(gene_name='APP', interaction_action='meman%', limit=1)
>>> first_result = r
>>> r.chemical
Memantine
>>> r.pubmed_ids
[21290839]
>>> r.chemical.drugbank_ids
[DB014043]See the installation documentation for more advanced
instructions. Also, check the change log at CHANGELOG.rst.
CTD provides also many online query interfaces and tools to analyse data on their website.
Please be aware of the CTD licence which allows the use of data only for research and educational purposes. Medical treatment decisions should not be made based on the information in CTD.
Any reproduction or use for commercial purpose is prohibited without the prior express written permission of the MDI Biological Laboratory and NC State University.
Comparative Toxicogenomics Database (CTD)
PyCTD
- Documented on Read the Docs
- Versioned on GitHub
- Tested on Travis CI
- Distributed by PyPI
- Chat on Gitter