Merge pull request #795 from AlexsLemonade/jashapiro/more-magic-2024

Update RNAseq magic file list and cheatsheet

RNA-seq/setup/magic-files.md

@@ -8,8 +8,31 @@ The sub-path for each file should be the same as that for `training-modules/RNA-
 
 Files are listed below by the notebook that produces them:
 
+- `02-gastric_cancer_tximeta.Rmd`
+  - `data/gastric-cancer/txi/gastric-cancer_tximeta.rds`
 - `setup/ref_notebooks/04-nb_cell_line_tximeta.Rmd` (participants create their own notebook for this step)
   - `data/NB-cell/txi/NB-cell_tximeta.rds`
 - `05-nb_cell_line_DESeq2.Rmd`
   - `results/NB-cell/NB-cell_DESeq_amplified_v_nonamplified.rds`
   - `results/NB-cell/NB-cell_DESeq_amplified_v_nonamplified_results.tsv`
+
+
+Note that the output files from `scripts/run_SRR585570.sh` script are already present at:
+
+- `/shared/data/training-modules/RNA-seq/data/gastric-cancer/salmon_quant/SRR585570/`
+- `/shared/data/training-modules/RNA-seq/QC/gastric-cancer/fastp/SRR585570/`
+- `/shared/data/training-modules/RNA-seq/QC/gastric-cancer/fastqc/SRR585570/`
+
+To make sure all of these directories can be found in uniform locations for "magic files", run the following commands (or similar) to create links (replacing `<date>`):
+
+```
+data_dir=/shared/data/training-data/<date>/RNA-seq/data/gastric-cancer
+qc_dir=/shared/data/training-data/<date>/RNA-seq/QC
+
+mkdir -p $data_dir
+mkdir -p $qc_dir
+
+ln -s /shared/data/training-modules/RNA-seq/data/gastric-cancer/salmon_quant ${data_dir}/salmon_quant
+ln -s /shared/data/training-modules/RNA-seq/QC/gastric-cancer ${qc_dir}/gastric-cancer
+```
+

module-cheatsheets/RNA-seq-cheatsheet.md

@@ -19,8 +19,8 @@ If you have a different version of R or other R packages, the documentation may
 - [`ggplot2`](#ggplot2)
 - [`tximeta` and `SummarizedExperiment`](#tximeta-and-summarizedexperiment)
 - [`stringr`, `readr`, `dplyr`](#stringr-readr-dplyr)
-- [`ComplexHeatmap`](#complexheatmap)
 - [`matrixStats`](#matrixstats)
+- [`ComplexHeatmap` and `EnhancedVolcano`](#complexheatmap-and-enhancedvolcano)
 - [Salmon](#salmon)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -111,14 +111,6 @@ Documentation for each of these packages can be accessed by clicking the package
 | [`readr`](https://readr.tidyverse.org/index.html)                 |[`write_rds()`](https://readr.tidyverse.org/reference/read_rds.html) | Write RDS                      | Writes data to a .RDS output file                                 |
 | [`dplyr`](https://dplyr.tidyverse.org/)                 | [`pull()`](https://dplyr.tidyverse.org/reference/pull.html)                      | Pull                              | Extracts a variable (column) as a vector                                          |
 
-### `ComplexHeatmap`
-
-Read the [`ComplexHeatmap` Complete Reference](https://jokergoo.github.io/ComplexHeatmap-reference/book/).
-
-| Library/Package               | Piece of Code                                                 | What it's called      | What it does                                                             |
-|-------------------------------|--------------------------------------------------------------|--------------------------------|--------------------------------------------------------------------------|
-| `ComplexHeatmap`              | [`Heatmap()`](https://rdrr.io/bioc/ComplexHeatmap/man/Heatmap.html) | Heatmap constructor | Constructs a `Heatmap` class object that can then be used to plot a heatmap    |
-| `ComplexHeatmap`              | [`HeatmapAnnotation()`](https://rdrr.io/bioc/ComplexHeatmap/man/HeatmapAnnotation.html) | Heatmap annotation constructor | Constructs a `HeatmapAnnotation` class object that can be used to annotate a heatmap |
 
 ### `matrixStats`
 
@@ -129,6 +121,19 @@ Read the [`matrixStats` package documentation (PDF)](https://cran.r-project.org/
 | `matrixStats`                 | [`rowVars()`](https://www.rdocumentation.org/packages/matrixStats/versions/1.3.0/topics/rowVars) | Row variance                   | Estimates the variance for each row in a matrix |
 | `matrixStats`                 | [`rowSds()`](https://search.r-project.org/CRAN/refmans/matrixStats/html/rowSds.html) | Row standard deviations | Estimates the standard deviations for each row in a matrix |
 
+<div style="page-break-after: always;"></div>
+
+### `ComplexHeatmap` and `EnhancedVolcano`
+
+Read the [`ComplexHeatmap` Complete Reference](https://jokergoo.github.io/ComplexHeatmap-reference/book/).
+Read the [`EnhancedVolcano` manual](https://bioconductor.org/packages/release/bioc/vignettes/EnhancedVolcano/inst/doc/EnhancedVolcano.html).
+
+| Library/Package               | Piece of Code                                                 | What it's called      | What it does                                                             |
+|-------------------------------|--------------------------------------------------------------|--------------------------------|--------------------------------------------------------------------------|
+| `ComplexHeatmap`              | [`Heatmap()`](https://rdrr.io/bioc/ComplexHeatmap/man/Heatmap.html) | Heatmap constructor | Constructs a `Heatmap` class object that can then be used to plot a heatmap    |
+| `ComplexHeatmap`              | [`HeatmapAnnotation()`](https://rdrr.io/bioc/ComplexHeatmap/man/HeatmapAnnotation.html) | Heatmap annotation constructor | Constructs a `HeatmapAnnotation` class object that can be used to annotate a heatmap |
+| `EnhancedVolcano`             | [`EnhancedVolcano()`](https://rdrr.io/bioc/EnhancedVolcano/man/EnhancedVolcano.html) | Enhanced volcano plot | Constructs a highly customizable volcano plot with colored and labeled points |
+
 
 ### Salmon