gDR -- data model
gDR team
gdr-support-d@gene.com Source:../../vignettes/gDR-data-model.Rmd
gDR-data-model.Rmd
Abstract
This vignette comprehensively describes the data model used in the gDRsuite.
Introduction
This vignette is dedicated to providing an in-depth exploration of the underlying data model employed in the gDR suite, with a focus on the versatile MultiAssayExperiment object – the cornerstone of the gDR ecosystem. The vignette delves into the intricacies of the data model, shedding light on how different components are organized within the MultiAssayExperiment object. As the basic and essential object in the gDR, the MultiAssayExperiment encapsulates the diverse dimensions of drug response data, providing a unified and coherent framework for analysis. Our primary goal is to equip users with a detailed understanding of the gDRsuite data model and its utilization within the MultiAssayExperiment object. Through practical examples and thorough explanations, we aim to demonstrate how gDRcore’s core functions and pipeline facilitate efficient analysis, providing valuable insights into drug response dynamics. More information about the data processing can be found in the gDRcore.
General overview of the data model
In the gDR suite, the culmination of drug response data is encapsulated in the form of a MultiAssayExperiment object, representing a versatile and cohesive framework for the analysis of diverse experimental scenarios.
Supported Experiments:
The gDR suite accommodates three primary types of experiments within the MultiAssayExperiment object:
single-agent
experiment: This involves the assessment of drug responses to a single agent, providing insights into individual treatment effects.combination
experiments: This explores the interactions between multiple agents, unraveling the complexities of combined drug treatments and their effects.co-dilution
experiments: Focused on studying the effects of diluting concentrations of compounds, codilution experiments provide valuable data on the concentration-dependent aspects of drug responses.
SummarizedExperiment objects:
Each experiment within the MultiAssayExperiment is represented as a SummarizedExperiment object. This encapsulates the essential components necessary for comprehensive analysis:
assays
: Containing the actual data, assays provide a numerical representation of drug responses and associated experimental measurements. In gDR, assays are represented by BumpyMatrix object.rowData
: Encompassing information related to features, rowData provides context on the entities being analyzed, such as drugs, compounds, or concentrations. In gDR, rowData are represented byDataFrame
object from S4VectorscolData
: Describing the experimental conditions, colData captures metadata associated with the cell lines, including tissues, reference division time, and any relevant covariates. In gDR, colData are represented byDataFrame
object from S4Vectorsmetadata
: Offering additional information about the experiment, metadata provides a contextual layer to enhance the understanding of the experimental setup.
MultiAssayExperiment object
At its core, the MultiAssayExperiment object is designed to hold a collection of SummarizedExperiment objects, each representing a distinct experiment type within the gDR suite. This simplicity ensures a clean and efficient organization of data, facilitating a user-friendly experience.
To extract specific experiments from the MultiAssayExperiment
object, the [[
operator can be used For example, to access
the data related to combination experiments, one can use
MAE[["combination"]]
, where MAE
represents the
MultiAssayExperiment
object.
To gain insights into the available experiments within the MultiAssayExperiment
object, the MultiAssayExperiment::experiments
function can
be used.
SummarizedExperiment object
The SummarizedExperiment object emerges as a pivotal structure, integrating drug response data with essential metadata. This versatile container plays a central role in the storage of information related to drugs, cell lines, and experimental conditions, providing a comprehensive foundation for nuanced analysis within the gDR.
The SummarizedExperiment object in gDR contains four essential components:
Assays
This section encapsulates the drug response data itself, offering a
numerical representation of experimental measurements. Whether it
involves single-agent studies, combination treatments, or co-dilution
experiments, the assays contain crucial data points for analysis. The
list of available assays for a given gDR experiment can be obtained
using SummarizedExperiment::assayNames
on the SummarizedExperiment
object. The extraction of a specific assay
can be done
using SummarizedExperiment::assay
function,
i.e. SummarizedExperiment::assay(se, "Normalized")
, where
se
is the SummarizedExperiment
object, and Normalized
is the name of the assay within the
experiment.
The gDR experiments contain two sets of assays. One set is for single-agent and co-dilution experiments (five basic assays), and another set is for combinations experiments (five basic assays plus four – combination-specific).
List of assays (combination-specific assays were marked with the asterisk):
- RawTreated – stores treated references
- Controls – represents untreated, control references
- Normalized – represents normalized data to compute RelativeViability and GRValues (default gDR normalization types)
- Averaged – stores averaged replicates computed by the mean and standard deviation
- Metrics – contains fitted response curves
- excess (*) – excess data for each pair of concentration values (represents Bliss excess, HSA excess, and data smoothing values)
- all_iso_points (*) stores isobologram points
- isobolograms (*) – stores isobologram curves
- scores (*) – scores data for each pair of concentration values (HSA score, Bliss Score, and CI (combination index) scores)
All assays are stored as BumpyMatrix objects.
Assays represented by numbers 3-9 additionally contain information
about normalization_type
to distinguish different metrics
calculated for each normalization type (RelativeViability and GRValues
by default).
In gDR BumpyMatrix
objects can be easily transformed into the data.table
object using gDRutils::convert_se_assay_to_dt
function.
This function also includes information from the rowData and
colData.
rowData
rowData
provides context on the features being analyzed,
rowData
is dedicated to information about drugs, compounds,
or concentrations with their annotations from the database. Additional
perturbations and replicates might be also stored in the
rowData
.
rowData
can be extracted from the SummarizedExperiment
object using SummarizedExperiment::rowData
function.
colData
colData
represents the experimental cell lines. This
includes details about the cell lines and their annotations.
colData
can be extracted from the SummarizedExperiment
object using SummarizedExperiment::colData
function.
metadata
metadata
offers an extra layer of information about the
experiment itself, metadata provides context to enhance comprehension.
This may include details about the experimental design, sources of data,
or any other relevant information that aids in the interpretation of
results.
metadata
information can be extracted using
S4Vectors::metadata
function. In gDR object the metadata
information is stored as a list.
Session info
## R version 4.3.0 (2023-04-21)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 22.04.3 LTS
##
## Matrix products: default
## BLAS: /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3
## LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so; LAPACK version 3.10.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_US.UTF-8 LC_COLLATE=en_US.UTF-8
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: Etc/UTC
## tzcode source: system (glibc)
##
## attached base packages:
## [1] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] BiocStyle_2.30.0
##
## loaded via a namespace (and not attached):
## [1] vctrs_0.6.5 cli_3.6.3 knitr_1.45
## [4] rlang_1.1.4 xfun_0.42 stringi_1.8.4
## [7] purrr_1.0.2 textshaping_0.3.7 jsonlite_1.8.9
## [10] glue_1.8.0 htmltools_0.5.7 ragg_1.2.7
## [13] sass_0.4.8 rmarkdown_2.25 evaluate_0.23
## [16] jquerylib_0.1.4 fastmap_1.1.1 yaml_2.3.8
## [19] lifecycle_1.0.4 memoise_2.0.1 bookdown_0.37
## [22] BiocManager_1.30.22 stringr_1.5.1 compiler_4.3.0
## [25] fs_1.6.3 systemfonts_1.0.5 digest_0.6.34
## [28] R6_2.5.1 magrittr_2.0.3 bslib_0.6.1
## [31] tools_4.3.0 pkgdown_2.0.7 cachem_1.0.8
## [34] desc_1.4.3