-
Notifications
You must be signed in to change notification settings - Fork 0
fix: resolve gDRstyle linting violations #59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
@@ -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). | ||
|
|
||
|
|
@@ -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) | ||
| ``` | ||
|
|
@@ -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") | ||
|
|
@@ -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. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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: |
||
|
|
||
| ```{r, echo=TRUE, results='asis', warning=FALSE, results='hide', message=FALSE} | ||
| # Run gDR pipeline | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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