Skip to content

Interaktive Visualisierung von Medikamentenwirkung auf Proteine/Interactive visualization of drug effects on proteins

Notifications You must be signed in to change notification settings

scibiome/SPIDER

Repository files navigation

SPIDER - Interaktive Visualisierung von Medikamentenwirkung auf Proteine/Interactive visualization of drug effects on proteins

Our platform provides an immersive experience for exploring and analyzing a segment of the dataset from Gonçalves et al.. With a primary focus on identifying associated proteins and drugs for individual or groups of proteins, SPIDER offers comprehensive tools for in-depth research.

This repository contains the code for the System for Protein, Interactions, Drugs, and Exploratory Research (SPIDER). To use SPIDER locally on your PC, we recommend using the Docker version of SPIDER. For detailed instructions, see the Docker installation instructions.

Structure

The code is divided into three main categories:

  1. Frontend - Code for the SPIDER frontend
  2. Backend - FastAPI server, Neo4j dump, and other utilities
  3. Docker - docker-compose.yml to install and run SPIDER in a Docker container
  4. db - Includes almost all files to create a neo4j docker image

These categories are further divided into subcategories.

Frontend

The frontend is divided into several components:

  1. public: Used images.
  2. src/components: Includes all the components of the web application.
    1. Database: List and information for used datasets.
    2. FAQ: General information, used licenses, and answers to common questions.
    3. Graph: Network graph and tools for the graph (e.g., filters).
    4. ListSearch: Search for a group of entities.
    5. NavigationBar: Allows access to all sub-websites.
    6. Overview: Show ProCan Plots.
    7. SearchBar: Search for one entity.
    8. Upload: Upload new data to the database.
  3. App: Main component of the React application.
  4. index: Entry point of the React application.

Backend

The backend is divided into several subcategories:

  1. data: Stores the uploaded files.
  2. data_info: Stores the uploaded md files.
  3. example: Contains example files that can be used for uploading data.
  4. help_data: Files created during data processing.
  5. help_tools: Programs that help with adding data to the database, performing investigations, and creating diagrams.
  6. neo4j_database_dump: Backup of the Neo4j database.
  7. plot_data: Contains the data for the ProCan plots.
  8. settings: Contains files that specify how an uploaded file should be integrated into the database.
  9. similarity_data: Calcukated similarity values.
  10. allgemeine_info: Contains all data for filter options.
  11. database: Contains all information about the used datasets.
  12. datasets: List of used datasets.
  13. file_converter: Integrates the uploaded file into the Neo4j database.
  14. main: FastAPI Server.
  15. updateDBInfo: Updates the allgemeine_info file after new data has been integrated into the database.

db

Contains almost all neo4j data to create a neo4j docker image. In addition, based on a neo4j backup, the database and transaction folders must be copied to the data folder. The executable jar files of apoc-5.12.0-core and neo4j-graph-data-science-2.5.5 must also be added to the plugins ornder.

  1. conf: Configuration files for neo4j.
  2. data: Folder which includes all data for the neo4j db.
  3. logs: Folder for debug and neo4j logs.
  4. plugins: Contains the neo4j plugins.

Development Setup

  • Install all necessary Python and JS libraries.
  • Setup a local Neo4j database (Version: 5.12.0 Community Edition) with the APOC and Graph Data Science Library. → Load backup into the new Neo4j database.
neo4j stop
neo4j-admin database load --from-path=C:\backup\backup neo4j --overwrite-destination=true
neo4j start

Note: change the file paths according to your configuration

CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.name);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.name);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.name);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.uid);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.uid);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.uid);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.drug_id);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.CHEMBL);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.COSMIC_ID);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.swiss);
CALL gds.graph.project("graph", "Protein", {PPI: {orientation: "UNDIRECTED"}});
  • Start the fastapi server
cd backend
python  -m uvicorn main:app 
  • Start the development server
cd frontend
npm start

Production-Setup

To use SPIDER, you have two options: either utilize Docker or set up your own server.


Docker

  1. Install Docker Desktop
  2. Optional: Restart your pc after the installation
  3. Download the docker-compose.yml from the docker folder of this repository. Important: Do not use the wrong docker-compose file!
  4. Open the terminal in the folder where you placed the docker-compose.yml and run the following command:
docker-compose up

(Optional: First run docker-compose pull) This process can take some time (approximately 40 minutes). 5. Call http://localhost:7474/browser/ and execute the following Neo4j cipher (user: neo4j, password: workwork).

CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.name);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.name);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.name);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.uid);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.uid);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.uid);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.drug_id);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.CHEMBL);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.COSMIC_ID);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.swiss);
CALL gds.graph.project("graph", "Protein", {PPI: {orientation: "UNDIRECTED"}});
  1. The website should be running on http://localhost:3000/

 

 


Server

  • Install all necessary python and js libraries
  • Setup a local Neo4j database (Version: 5.12.0 Community Edition) with the APOC and Graph Data Science Library. → load backup in to the new neo4j database
neo4j stop
neo4j-admin database load --from-path=C:\backup\backup neo4j --overwrite-destination=true
neo4j start

Note: change the file paths according to your configuration

CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.name);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.name);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.name);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.uid);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.uid);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.uid);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.drug_id);
CREATE INDEX IF NOT EXISTS FOR (d:Drug) ON (d.CHEMBL);
CREATE INDEX IF NOT EXISTS FOR (c:Cell_Line) ON (c.COSMIC_ID);
CREATE INDEX IF NOT EXISTS FOR (p:Protein) ON (p.swiss);
CALL gds.graph.project("graph", "Protein", {PPI: {orientation: "UNDIRECTED"}});
  • Start the fastapi server
cd backend
python  -m uvicorn main:app 
  • Start the development server
cd frontend
npm run build
cd build
python -m SimpleHTTPServer 7000

Licensed content

  • DrugBank under Creative Common's Attribution-NonCommercial 4.0 International License. Link to download
  • BioGRID under MIT License. Link to download
  • Cell Line node picture: Image of a biology cancer cell, obtained from Iconduck and licensed under CC BY 3.0. Link to image
  • Spider picture: Modified image of bug spider 2, sourced from Iconduck and licensed under CC0. Link to image

About

Interaktive Visualisierung von Medikamentenwirkung auf Proteine/Interactive visualization of drug effects on proteins

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published