--- title: "DrDimont: Drug Response Prediction from Differential Multi-Omics Networks" author: "Katharina Baum, Pauline Hiort, Julian Hugo, Spoorthi Kashyap, Nataniel Mueller, and Justus Zeinert" date: "`r Sys.Date()`" output: rmarkdown::html_vignette: toc: true vignette: > %\VignetteIndexEntry{Drug Response Prediction from Differential Multi-Omics Networks} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- ```{r, include = FALSE} knitr::opts_chunk$set( collapse = TRUE, comment = "#>" ) ``` ## Introduction The main purpose of the DrDimont pipeline is to easily and efficiently generate, reduce, and combine molecular networks from two groups or conditions (e.g., of patients) to compute a differential drug interaction score based on drug targets. This allows for improved predictions of the effect of drugs (e.g., for cancer) on two groups with different characteristics. ![DrDimont Pipeline Overview](220401_overview.png){width=80%} (Figure adapted from Figure 1A by Hiort et al. (2022)) ## Installation The R package `DrDimont` can be installed via CRAN. The R dependencies of the package will also be installed when installing the package. The complete source code can be accessed through https://gitlab.com/PHiort/DrDimont. The R package can be installed with: ```{r setup1, message=FALSE, warning=FALSE, eval=FALSE} install.packages('DrDimont') ``` After installation, you can load the package into your session with: ```{r setup2, message=FALSE} library(DrDimont) ``` ### Installation of Python and its dependencies The pipeline uses a Python script for one of the intermediate steps. For differential drug response score computation, Python (3.8 or 3.9) has to be installed on the system prior to running DrDimont. Please install either the standalone Python 3.9 (or 3.8) (https://www.python.org/downloads/), or Python via Anaconda (https://www.anaconda.com/products/distribution) or via miniconda (https://docs.conda.io/en/latest/miniconda.html) before running DrDimont. If Python is installed on your system, the `install_python_dependencies()` function of DrDimont can be used to install the required Python dependencies. The Python packages will be installed in a virtual python or conda environment called 'r-DrDimont'. Depending on which Python package manager (standalone or anaconda/miniconda Python) is installed on your system, the dependencies can be installed using pip (default; if standalone Python is installed): ```{r, echo=TRUE, warning=FALSE, eval=FALSE} install_python_dependencies(package_manager="pip") ``` or conda (if anaconda/miniconda Python is installed): ```{r, echo=TRUE, warning=FALSE, eval=FALSE} install_python_dependencies(package_manager="conda") ``` ATTENTION : When using pip, Python version 3.8 or 3.9 must be installed on the system (currently one of the Python dependencies ('ray') only work with Python <= 3.9). When using conda Python 3.9 will be automatically installed in the conda environment. If the installation does not work with DrDimont's internal function please refer to a manual installation of the libraries as described below. To manually create and install the python packages in the `r-DrDimont` environment, please run the following on your command line (outside of R): With conda run: ```{bash, echo=TRUE, warning=FALSE, eval=FALSE} conda create -n r-DrDimont -c conda-forge --yes python=3.9 conda activate r-DrDimont pip install numpy tqdm igraph ray ``` With pip run: ```{bash, echo=TRUE, warning=FALSE, eval=FALSE} #on Windows run the following in your home folder: mkdir .\Documents\.virtualenvs\ python -m venv .\Documents\.virtualenvs\r-DrDimont .\Documents\.virtualenvs\r-DrDimont\Scripts\activate pip install --upgrade pip numpy tqdm igraph ray # on Linux and Mac run the following in your home folder: mkdir .virtualenvs/ python -m venv .virtualenvs/r-DrDimont source .virtualenvs/r-DrDimont/bin/activate pip install --upgrade pip numpy tqdm igraph ray ``` ATTENTION : The python dependencies have to be installed into a virtual or conda environment with the name `r-DrDimont` otherwise the execution of the Python script will not work. A text file (`requirments_pip.txt` or `requirements_conda.txt`) with all required packages can also be downloaded from gitlab in the `inst/` directory or you can find them in your R package directory folder in the `DrDimont/` folder. ## Example Data Set Description The following exemplary pipeline application showcases the usage of molecular breast cancer data with ER+ (Estrogen receptor-positive) patient samples as group A and ER- (Estrogen receptor-negative) as group B. A reduced exemplary data set is included within the package. The breast cancer data by Krug et al. (2020) used for this tutorial is already preprocessed and only includes samples with tumor purity > 0.5 and known ER status. Metabolite data was sampled randomly to generate distributions similar to those reported, e.g., in Terunuma et al. (2014). The data set contains observations from: * 78 ER+ samples * 34 ER- samples | |Number of genes, etc.|Preprocessing|Identifier| |---|---|---|---| |mRNA|13915|quantified mRNA expression; log2-transformed FPKM values, NAs set to -11, removed mRNAs with > 90% of zero measurements, reduced|gene name| |Protein|5809 (ER+) and 5845 (ER-)|quantified proteomics data; normalized, standardized, removed proteins with > 20% NAs, reduced|NCBI RefSeq ID, gene name| |phosphosites|10272 (ER+) and 11318 (ER-)|quantified phosphoproteomics data; normalized, removed phosphosites with > 20% NAs, reduced|phosphosite, gene name, NCBI RefSeq ID| |Metabolite| 275 from 33 (ER+) and 34 (ER-) samples|randomly sampled metabolomics data; removed metabolites with > 50% NAs|biochemical name, PubChem ID, metabolon ID| To limit runtime and space requirements of the example we reduced the mRNA, protein and phosphosite data to a random set of 50 genes. The 50 genes were randomly selected from the set of genes with known drug targets from The Drug Gene Interaction Database (https://www.dgidb.org/). The metabolite data was also randomly reduced to 50 metabolites. ### Load the data First you load the pre-processed data. This data is included in the package and does not need to be manually loaded but can be directly accessed once `library(DrDimont)` is called. ```{r Load data} data("mrna_data") data("protein_data") data("phosphosite_data") data("metabolite_data") data("metabolite_protein_interactions") data("drug_gene_interactions") ``` ### Transform the data to the required input format After loading the data, you can use formatting functions to bring your data into the required input formats: * make_layer() - creates individual molecular layers from raw data and unique identifiers * make_connection() - specifies connections between two individual layers * make_drug_target() - formats drug target interactions #### Create individual layers data structure from the molecular data Before running the pipeline, you can create individual layer objects using `make_layer()`. Please supply raw data stratified over two patient groups and unique identifiers for the molecular entities, e.g, genes. The function `make_layer()` requires the following input parameters: `name`, `data_groupA`, `data_groupB`, `identifiers_groupA` and `identifiers_groupB`. Please give each layer a unique name with the `name` argument. The `identifiers_groupA` and `identifiers_groupB` parameters are given data frames which should contain one or more uniquely named columns with identifiers of the molecular entities in the rows, e.g., gene names. You can supply the raw data with the `data_groupA` and `data_groupB` parameters with the molecular entities (e.g, genes) as rows and the samples as columns. Please make sure that the identifiers of the molecular entities are in the same order as the columns in the raw data. If you have only one group to analyse then you can set the parameters `data_groupB=NULL` and `identifiers_groupB=NULL`. Run the code below for exemplary raw data frames: ```{r} # Data inspection mrna_data$groupA[1:3, 1:5] protein_data$groupA[1:3, 1:5] phosphosite_data$groupA[1:3, 1:5] metabolite_data$groupA[1:3, 1:5] ``` Run the code below to create the individual layers: ```{r Create layers} # Create individual layers mrna_layer <- make_layer(name="mrna", data_groupA=mrna_data$groupA[,-1], data_groupB=mrna_data$groupB[,-1], identifiers_groupA=data.frame(gene_name=mrna_data$groupA$gene_name), identifiers_groupB=data.frame(gene_name=mrna_data$groupB$gene_name)) protein_layer <- make_layer(name="protein", data_groupA=protein_data$groupA[, c(-1,-2)], data_groupB=protein_data$groupB[, c(-1,-2)], identifiers_groupA=data.frame(gene_name=protein_data$groupA$gene_name, ref_seq=protein_data$groupA$ref_seq), identifiers_groupB=data.frame(gene_name=protein_data$groupB$gene_name, ref_seq=protein_data$groupB$ref_seq)) phosphosite_layer <- make_layer(name="phosphosite", data_groupA=phosphosite_data$groupA[, c(-1,-2, -3)], data_groupB=phosphosite_data$groupB[, c(-1,-2, -3)], identifiers_groupA=data.frame(phosphosite_data$groupA[, 1:3]), identifiers_groupB=data.frame(phosphosite_data$groupB[, 1:3])) metabolite_layer <- make_layer(name="metabolite", data_groupA=metabolite_data$groupA[, c(-1,-2, -3)], data_groupB=metabolite_data$groupB[, c(-1,-2, -3)], identifiers_groupA=data.frame(metabolite_data$groupA[, 1:3]), identifiers_groupB=data.frame(metabolite_data$groupB[, 1:3])) ``` Run the code below to create a list of all individual layers for the pipeline input: ```{r Make layers list} all_layers <- list(mrna_layer, protein_layer, phosphosite_layer, metabolite_layer) ``` #### Create inter-layer connections data structure The inter-layer connections can be supplied by the user with `make_connection()`. The parameters `from` and `to` have to match to a name given in the previously created layers by `make_layer()`. The established connection will result in an undirected combined graph. The parameter `group` indicates whether the connection will be applied to `both` groups (default) or only group `A` or `B`. There are two options to connect layers: (i) based on identical identifiers of entities, or (ii) based on a given interaction table. For (i), two layers should contain one matching column name in their `identifiers_groupA`/`identifiers_groupB` data frames that is passed as the parameter `connect_on`. Two entities in the different layers with the same ID therein are connected with an edge of fixed weight (indicated by the `weight` parameter, default 1). For example: ```{r eval=FALSE} # (i) make inter-layer connection make_connection(from='mrna', to='protein', connect_on='gene_name', weight=1, group="both") ``` For (ii), an interaction table containing three columns is required. Two columns should contain entity IDs that are also given in the respective identifiers `identifiers_groupA`/`identifiers_groupB` of the two layers to be connected. One column of those should have the same name as a column name given in the `identifiers_groupA`/`identifiers_groupB` data frames of one layer and the second column the same for the second layer. The third column should contain the weights with which the respective entities of the two layers are to be connected. See `data(metabolite_protein_interactions)` for an exemplary interaction table. The table contains the columns "pubchem_id" also given for the metabolite layer, "gene_name" also given for the protein layer, and "combined_score" containing the weights for the respective interactions: ```{r} # Data inspection metabolite_protein_interactions[1:3, ] ``` The interaction table is passed to the `connect_on` parameter of `make_connection()` and the column name of the column containing the weights to the `weight` parameter. For example: ```{r eval=FALSE} # (ii) make inter-layer connection make_connection(from='protein', to='metabolite', connect_on=metabolite_protein_interactions, weight='combined_score', group="both") ``` If you have only one layer you can skip the next step and set the parameter `inter_layer_connections=NULL` later on. Run the code below to create a list of all inter-layer connections for pipeline input: ```{r Inter-layer connections} all_inter_layer_connections = list( make_connection(from='mrna', to='protein', connect_on='gene_name', weight=1, group="both"), make_connection(from='protein', to='phosphosite', connect_on='gene_name', weight=1, group="both"), make_connection(from='protein', to='metabolite', connect_on=metabolite_protein_interactions, weight='combined_score', group="both") ) ``` #### Create drug-target interaction data structure To run the entire pipeline, drug-target interactions are required. For that you need an interaction table mapping drugs to their targets, e.g, proteins. The table should contain two columns: one column containing the drug ids with the name `drug_name` and another column containing the drug targets with a name matching a column name in the `identifiers_groupA`/`identifiers_groupB` data frames of the target layer. The example data contains a table from The Drug Gene Interaction Database providing interactions of drugs with genes. The exemplary data frame has three columns (gene_name, drug_name, drug_chembl_id), one containing the gene names also given for the target protein layer, the second containing the drug names which are used to identify the drugs and a third column containing the ChEMBL IDs of drugs which will be ignored in the pipeline. The data frame of the drug-target interactions should have an column named `drug_name` containing drug identifiers. Example: ```{r} # Data inspection drug_gene_interactions[1:3, ] ``` The function `make_drug_target()` generates the required format of the drug-target interactions for the pipeline. The parameter `target_molecules` should match one of the layer names, e.g., `protein`. The data frame supplied with the parameter `interaction_table` should map drugs to their target as described above. The column in the interaction table containing the targets should be given with the `match_on` parameter, e.g, `match_on=gene_name` for `protein` as targets. Run the code below to create a list containing the drug-target input for the pipeline: ```{r Make drug-target interaction} all_drug_target_interactions <- make_drug_target( target_molecules='protein', interaction_table=drug_gene_interactions, match_on='gene_name') ``` #### Check input data structures When the input data structures of the individual layers, the inter-layer connections, and the drug target interactions are created they are checked automatically for validity. Additionally, the function below checks for a variety of possible input formatting and connection errors and reports registered data set sizes (samples, entities) for the user to compare with the intended input. ```{r} return_errors(check_input(layers=all_layers, inter_layer_connections=all_inter_layer_connections, drug_target_interactions=all_drug_target_interactions)) ``` ## Run the complete pipeline The pipeline can be run entirely or in individual steps. To set global pipeline options you can create a settings list using the `drdimont_settings()` function. This function contains default parameters that can be modified as shown below. For a detailed explanation of all possible settings and parameters please refer to the function documentation by calling `?drdimont_settings()`. Please be aware of the Python script used in one of the pipeline steps (see Requirements above). If you have installed python and the required packages via pip then you should set the `drdimont_settings()` parameter `conda=FALSE"`. If you have installed python and the required packages via conda then set the `drdimont_settings()` parameters `conda=TRUE`. `drdimont_settings()` will automatically check if Python can be found and prints a warning if not. The intermediate pipeline and drug response scores output (parameter `save_data`) is deactivated (default) but especially for large data files consider turning it on. You can specify the output location of files with the `saving_path` parameter. If not specified all files will be written to a temporary file created by R. For this example, the data will be saved in a temporary directory. If you want to save the data elsewhere you need to change the parameter `saving_path` below. The intermediate output data includes RData-files of the correlation matrices, the individual graphs, the combined graphs, the drug target edges, the interaction score graphs, and the differential score graph. The drug response scores are saved in a tsv-file in the specified output directory if `save_data=TRUE`. See Running the individual pipeline steps and call `?drdimont_settings()` for further explanations of settings parameters. Run the following code to create a settings list for the example: ```{r Settings} example_settings <- drdimont_settings( handling_missing_data = list( default = "pairwise.complete.obs", mrna = "all.obs"), reduction_method = "pickHardThreshold", r_squared=list(default=0.65, metabolite=0.1), cut_vector=list(default=seq(0.2, 0.65, 0.01)), conda=FALSE, save_data = FALSE, saving_path = tempdir()) # disable multi-threading for example run; # not recommended for actual data processing WGCNA::disableWGCNAThreads() ``` To run the entire pipeline from beginning-to-end the `run_pipeline()` function can be used: ```{r Run pipeline, eval=FALSE} run_pipeline(layers=all_layers, inter_layer_connections=all_inter_layer_connections, drug_target_interactions=all_drug_target_interactions, settings=example_settings) ``` ## Run the individual pipeline steps The pipeline can also be used in a modular fashion. The modules then refer to the different steps: