Mercurial > repos > kkonganti > cfsan_bettercallsal
diff 0.6.1/modules/multiqc/README.md @ 11:749faef1caa9
"planemo upload"
author | kkonganti |
---|---|
date | Tue, 05 Sep 2023 11:51:40 -0400 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/0.6.1/modules/multiqc/README.md Tue Sep 05 11:51:40 2023 -0400 @@ -0,0 +1,67 @@ +# NextFlow DSL2 Module + +```bash +MULTIQC +``` + +## Description + +Generate an aggregated [**MultiQC**](https://multiqc.info/) report. This particular module **will only work** within the framework of `cpipes` as in, it uses many `cpipes` related UNIX absolute paths to store and retrieve **MultiQC** related configration files and `cpipes` context aware metadata. It also uses a custom logo with filename `FDa-Logo-Blue---medium-01.png` which should be located inside an `assets` folder from where the NextFlow script including this module will be executed. + +\ + + +### `input:` + +___ + +Type: `path` + +Takes in NextFlow input type of `path` which points to many log files that **MultiQC** should parse. + +Ex: + +```groovy +[ '/data/sample1/centrifuge/cent_output.txt', '/data/sample1/kraken/kraken_output.txt'] ] +``` + +\ + + +### `output:` + +___ + +#### `report` + +Type: `path` + +Outputs a NextFlow output type of `path` pointing to the location of **MultiQC** final HTML report. + +\ + + +#### `data` + +Type: `path` + +NextFlow output type of `path` pointing to the data files folder generated by **MultiQC** which were used to generate plots and HTML report. + +\ + + +#### `plots` + +Type: `path` +Optional: `true` + +NextFlow output type of `path` pointing to the plots folder generated by **MultiQC**. + +\ + + +#### `versions` + +Type: `path` + +NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.