Badapple2

Bioassay data associative promiscuity pattern learning engine V2.

For smaller use cases one can use the Badapple2 web app: https://chiltepin.health.unm.edu/badapple2

About

Badapple is a method for detecting likely promiscuous compounds via their associated scaffolds, using public bioassay data from PubChem. For more information please see the About Page.

The code contained in this repo is for building and analyzing the Badapple databases. If you would like to view the code for the Badapple UI or API please visit the repos below:

• API: https://github.com/unmtransinfo/Badapple2-API
• UI: https://github.com/unmtransinfo/Badapple2-UI

badapple_classic

If you want to setup the badapple_classic DB follow the instructions here.

badapple2

The steps below outline how one can setup the badapple2 DB.

Easy Setup

Option 1: Docker

Use this option to install a Docker image with the DB.

See the docker README file here

Option 2: PostgreSQL

Use this option to install the DB directly on your system using PostgreSQL.

1. Follow the PostgreSQL setup instructions here
2. Download badapple2.pgdump.
   • Note: If your use case needs the "activity" table, then instead download badapple2_full.pgdump
3. Create the DB: createdb badapple2
4. Load DB from dump file: pg_restore -O -x -v -d badapple2 badapple2.pgdump
   • Note: If you're including the "activity" table then use: pg_restore -O -x -v -d badapple2 badapple2_full.pgdump

Setup "from-scratch"

You can skip this section if you setup the DB using the steps from above

If you would like to run the entire workflow used to create the badapple2 DB, then please follow the instructions here.

Code Usage

If you'd like to run the scripts/code contained within this repository then you will need to follow the setup guidelines outlined below.

System Requirements

Code is expected to work on Linux systems.

MacOS and Windows users will need need to modify the conda environment.yml file. Make sure to follow appropriate installation guidelines for other dependencies (PostgreSQL, Docker). Please note that packages/dependencies may function differently across operating systems.

Python Setup

1. Setup conda (see the Miniconda Site for more info)
   • (Optional) I'd recommend using the libmamba solver for faster install times, see here
2. Install the Badapple2 environment: conda env create -f environment.yml
   • This will create a new conda env with name badapple2. If you wish, you can change the first line of environment.yml prior to the command above to change the name.

PostgreSQL Setup

1. Install PostgreSQL with the RDKit cartridge (requires sudo): sudo apt install postgresql-14-rdkit
2. (Option 1) Make your user a superuser prior to DB setup:
   1. Switch to postgres user: (base) <username>@<computer>:~$ sudo -i -u postgres
   2. Make yourself a superuser: psql -c "CREATE ROLE <username> WITH SUPERUSER PASSWORD '<password>'"
3. (Option 2) If you don't want to make <username> a superuser, follow the steps below:
   1. When running DB setup commands, prepend sudo -u postgres to DB setup commands. For example, instead of createdb <DB_NAME> use sudo -u postgres createdb <DB_NAME>.
   2. After setting up the DB as postgres you can grant permissions to <username> to access the DB as <username> like so:

   sudo -i -u postgres
   psql -d <DB_NAME> -c "CREATE ROLE <username> WITH LOGIN PASSWORD '<password>'"
   psql -d <DB_NAME> -c "GRANT SELECT ON ALL TABLES IN SCHEMA public TO <username>"
   psql -d <DB_NAME> -c "GRANT SELECT ON ALL SEQUENCES IN SCHEMA public TO <username>"
   psql -d <DB_NAME> -c "GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO <username>"