From 1ae0c21d84c2deb43706c5b095396fd512878091 Mon Sep 17 00:00:00 2001
From: Laurent Modolo <laurent.modolo@ens-lyon.fr>
Date: Fri, 4 Jun 2021 10:18:48 +0200
Subject: [PATCH] multiqc: add comments on usage
---
src/nf_modules/multiqc/main.nf | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/src/nf_modules/multiqc/main.nf b/src/nf_modules/multiqc/main.nf
index f7ac1dd6..c239178d 100644
--- a/src/nf_modules/multiqc/main.nf
+++ b/src/nf_modules/multiqc/main.nf
@@ -1,3 +1,25 @@
+// multiqc generate nice html report combining lots of differents bioinformatics
+// tools report.
+//
+// EXAMPLE:
+
+/*
+include { multiqc }
+ from './nf_modules/multiqc/main'
+ addParams(
+ multiqc_out: "QC/"
+ )
+
+multiqc(
+ report_a
+ .mix(
+ report_b,
+ report_c,
+ report_d
+ )
+)
+*/
+
version = "1.9"
container_url = "lbmc/multiqc:${version}"
--
GitLab