Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: gDR
Title: Umbrella package for R packages in the gDR suite
Version: 1.9.1
Version: 1.9.2
Date: 2025-10-30
Authors@R: c(
person("Allison", "Vuong", , "vuong.allison@gene.com", role = "aut"),
Expand Down
5 changes: 4 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## gDR 1.9.2 - 2026-05-18
* apply updated gDRstyle rules

## gDR 1.9.1 - 2025-10-30
* synchronize Bioconductor and GitHub versioning

Expand Down Expand Up @@ -126,4 +129,4 @@
* add example data

## gDR 0.0.0.1 - 2021-02-03
* initial version
* initial version
12 changes: 6 additions & 6 deletions R/data.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Small data.table with raw data used for processing via gDR
#'
#' A dataset containing the ReadoutValues for single-agent experiments
#' A dataset containing the ReadoutValues for single-agent experiments
#' made-up of 10 drugs and 10 cell lines
#'
#' @format A data frame with 3300 rows and 12 variables:
Expand All @@ -18,16 +18,16 @@
#' \item{BackgroundValue}{backgroud value}
#' \item{Duration}{duration}
#' }
#'
#'
#' @usage data(small_data)
#'
#'
#' @keywords data
#' @return data.table
"small_data"

#' Small data.table with raw combo data used for processing via gDR
#'
#' A dataset containing the ReadoutValues for combo experiments made-up of
#' A dataset containing the ReadoutValues for combo experiments made-up of
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase 'made-up of' should be 'made up of' when used as a verb phrase. 'Made-up' with a hyphen is typically an adjective.

#' A dataset containing the ReadoutValues for combo experiments made up of

#' 3 drugs, 2 co-drugs, and 2 cell lines
#'
#' @format A data frame with 3600 rows and 16 variables:
Expand All @@ -49,9 +49,9 @@
#' \item{BackgroundValue}{backgroud value}
#' \item{Duration}{duration}
#' }
#'
#'
#' @usage data(small_combo_data)
#'
#'
#' @keywords data
#' @return data.table
"small_combo_data"
2 changes: 1 addition & 1 deletion R/gDR-package.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' @note To learn more about functions start with `help(package = "gDR")`
#' @note To learn more about functions start with `help(package = "gDR")`
#' @keywords internal
#' @return package help page
"_PACKAGE"
Expand Down
4 changes: 2 additions & 2 deletions R/import_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
#' @param results_file character, with datapaths and names of results file(s)
#' or character with file path of results file(s)
#' @param instrument string with type of instrument used
#'
#'
#' @examples
#' td <- get_test_data()
#' i_df <- import_data(manifest_path(td), template_path(td), result_path(td))
#'
#'
#' @return a \code{data.table}
#'
#' @keywords import
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat/test-utils.R
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
context("utils")

test_that("import_data", {

# Define path for data stored in gDR package
dataDir <- system.file("extdata", "data1", package = "gDRimport")

# Extract path for example raw_data
manifest <- list.files(dataDir, pattern = "manifest", full.names = TRUE)
template <- list.files(dataDir, pattern = "Template", full.names = TRUE)
Expand Down
28 changes: 14 additions & 14 deletions vignettes/gDR.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,26 @@ We are happy to share with you our packages for importing, processing and managi
- gDRutils
- gDRtestData

## Data structures
## Data structures
The gDR data model is based on the SummarizedExperiment and BumpyMatrix. If readers are unfamiliar with these data models, we recommend first reading [SummarizedExperiment vignettes](https://bioconductor.org/packages/release/bioc/vignettes/SummarizedExperiment/inst/doc/SummarizedExperiment.html), followed by the [BumpyMatrix vignettes](https://www.bioconductor.org/packages/devel/bioc/vignettes/BumpyMatrix/inst/doc/BumpyMatrix.html). The SummarizedExperiment data structure enables ease of subsetting within the SummarizedExperiment object, but also provides ease when trying to correlate drug response data with genomic data, as these data may jointly stored in a MultiAssayExperiment. The BumpyMatrix allows for storage of multi-dimensional data while retaining a matrix abstraction.

This data structure is the core data structure that all downstream processing functions as well as visualization tools operate off of.

## Overview
The gDR suite was designed in a modular manner, such that a user can jump into the "standard" end-to-end gDR processing pipeline at several entry points as is suitable for his or her needs. The full pipeline involves:

```
```
manifest, template(s), raw data
|
| 1. Aggregating all raw data and metadata
| into a single long table.
| into a single long table.
|
V
single, long table
|
| 2. Transforming the long table into
| a SummarizedExperiment object with BumpyMatrix assays
| by specifying what columns belong on rows,
| 2. Transforming the long table into
| a SummarizedExperiment object with BumpyMatrix assays
| by specifying what columns belong on rows,
| columns, and nested.
|
V
Expand All @@ -65,11 +65,11 @@ The gDR suite was designed in a modular manner, such that a user can jump into t
V
SummarizedExperiment object
with raw, treated, normalized,
averaged, and metric assays,
averaged, and metric assays,
ready for use by downstream visualization

```

A user should be able to enter any part of this pipeline as long as they are able to create the intermediate object
(i.e., the individual manifest, template, and raw data files, or a single, long table, or a SummarizedExperiment object with Bumpy assays).

Expand All @@ -93,11 +93,11 @@ template_path(td)
result_path(td)
```

Using the convenience function `import_data`, the long table is easily created:
Using the convenience function `import_data`, the long table is easily created:

```{r, echo=TRUE, results='asis', warning=FALSE, results='hide', message=FALSE}
```{r, echo=TRUE, results='asis', warning=FALSE, results='hide', message=FALSE}
# Import data
imported_data <-
imported_data <-
import_data(manifest_path(td), template_path(td), result_path(td))
head(imported_data)
```
Expand Down Expand Up @@ -128,7 +128,7 @@ Note that this has created a SummarizedExperiment object with `rowData`, `colDat


## Averaging and fitting data (3)
Next, we can average and fit the data of interest.
Next, we can average and fit the data of interest.
```{r, echo=TRUE, results='asis', warning=FALSE, results='hide', message=FALSE}
se <- average_SE(se, data_type = "single-agent")
se <- fit_SE(se, data_type = "single-agent")
Expand All @@ -138,7 +138,7 @@ se
```

## runDrugResponseProcessingPipeline
Steps (2) and (3) can be combined into a single step through a convenience function: `runDrugResponseProcessingPipeline`. Moreover, the output is `MultiAssayExperiment` object with one experiment per each detected data type. Currently four data types are supported: 'single-agent', 'cotreatment', 'codilution' and 'matrix'. The first three data types are processed via the 'single-agent' model while the 'marix' data is processed via the 'combintation' model.
Steps (2) and (3) can be combined into a single step through a convenience function: `runDrugResponseProcessingPipeline`. Moreover, the output is `MultiAssayExperiment` object with one experiment per each detected data type. Currently four data types are supported: 'single-agent', 'cotreatment', 'codilution' and 'matrix'. The first three data types are processed via the 'single-agent' model while the 'marix' data is processed via the 'combintation' model.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This line contains typos: 'marix' should be 'matrix' and 'combintation' should be 'combination'. Additionally, consider adding the article 'a' before 'MultiAssayExperiment' for better grammatical flow. Corrected text: Steps (2) and (3) can be combined into a single step through a convenience function: runDrugResponseProcessingPipeline. Moreover, the output is a MultiAssayExperiment object with one experiment per each detected data type. Currently four data types are supported: 'single-agent', 'cotreatment', 'codilution' and 'matrix'. The first three data types are processed via the 'single-agent' model while the 'matrix' data is processed via the 'combination' model.


```{r, echo=TRUE, results='asis', warning=FALSE, results='hide', message=FALSE}
# Run gDR pipeline
Expand Down