From 1a41155e6f7fab279f2ef4c7ebeeef6887e76bdd Mon Sep 17 00:00:00 2001
From: Dominik Brilhaus <brilhaus@nfdi4plants.org>
Date: Tue, 18 Mar 2025 17:23:11 +0100
Subject: [PATCH] move deseq readme to cwl docs section

---
 workflows/deseq2/README.md    | 35 -----------------------------------
 workflows/deseq2/workflow.cwl | 14 +++++++++++++-
 2 files changed, 13 insertions(+), 36 deletions(-)
 delete mode 100644 workflows/deseq2/README.md

diff --git a/workflows/deseq2/README.md b/workflows/deseq2/README.md
deleted file mode 100644
index 8b68f05..0000000
--- a/workflows/deseq2/README.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# DESeq2
-
-Workflow used for **differential gene expression analysis**
-
-## DESeq2 docs
-
-- https://bioconductor.org/packages/release/bioc/html/DESeq2.html
-
-## Importing kallisto output with tximport
-
-- https://bioconductor.org/packages/release/bioc/vignettes/tximport/inst/doc/tximport.html#kallisto
-
-## Run pure script (to test)
-
-### Install R dependencies for deseq2
-
-```R
-if (!require("BiocManager", quietly = TRUE))
-    install.packages("BiocManager")
-
-BiocManager::install("DESeq2")
-library("DESeq2")
-
-BiocManager::install("tximport")
-library("tximport")
-
-BiocManager::install("rhdf5")
-library("rhdf5")
-```
-
-## Multi-package containers
-
-- R and combinations of library dependencies are available as multi-package containers from [BioContainers](https://github.com/BioContainers/multi-package-containers)
-- Searched for `repo:BioContainers/multi-package-containers deseq2 tximport rhdf5`
-- and found `quay.io/biocontainers/mulled-v2-05fd88b9ac812a9149da2f2d881d62f01cc49835:a10f0e3a7a70fc45494f8781d33901086d2214d0-0` :tada:
diff --git a/workflows/deseq2/workflow.cwl b/workflows/deseq2/workflow.cwl
index 9933719..0f1d68d 100644
--- a/workflows/deseq2/workflow.cwl
+++ b/workflows/deseq2/workflow.cwl
@@ -1,7 +1,8 @@
 #!/usr/bin/env cwl-runner
 
 doc: |
-  DESeq2 example workflow
+  DESeq2 example workflow for **differential gene expression analysis**
+  
   This workflow runs DESeq2 on the output of the kallisto workflow
   and the metadata file.
   It runs an R script, deseq2.R, which ideally should be split into three sub scripts and accordingly three workflow steps
@@ -9,6 +10,17 @@ doc: |
     2. Prep / run deseq2
     3. Plot results
 
+  ## DESeq2 docs:
+    https://bioconductor.org/packages/release/bioc/html/DESeq2.html
+
+  ## Importing kallisto output with tximport
+    https://bioconductor.org/packages/release/bioc/vignettes/tximport/inst/doc/tximport.html#kallisto
+
+  ## Multi-package containers
+  - R and combinations of library dependencies are available as multi-package containers from [BioContainers](https://github.com/BioContainers/multi-package-containers)
+  - Searched for `repo:BioContainers/multi-package-containers deseq2 tximport rhdf5`
+  - and found `quay.io/biocontainers/mulled-v2-05fd88b9ac812a9149da2f2d881d62f01cc49835:a10f0e3a7a70fc45494f8781d33901086d2214d0-0` :tada:
+
 cwlVersion: v1.2
 class: CommandLineTool
 hints:
-- 
GitLab