Mercurial > repos > kkonganti > cfsan_centriflaken
annotate 0.3.0/modules/multiqc/README.md @ 92:295c2597a475
"planemo upload"
| author | kkonganti |
|---|---|
| date | Tue, 19 Jul 2022 10:07:24 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| kkonganti@92 | 1 # NextFlow DSL2 Module |
| kkonganti@92 | 2 |
| kkonganti@92 | 3 ```bash |
| kkonganti@92 | 4 MULTIQC |
| kkonganti@92 | 5 ``` |
| kkonganti@92 | 6 |
| kkonganti@92 | 7 ## Description |
| kkonganti@92 | 8 |
| kkonganti@92 | 9 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. |
| kkonganti@92 | 10 |
| kkonganti@92 | 11 \ |
| kkonganti@92 | 12 |
| kkonganti@92 | 13 |
| kkonganti@92 | 14 ### `input:` |
| kkonganti@92 | 15 |
| kkonganti@92 | 16 ___ |
| kkonganti@92 | 17 |
| kkonganti@92 | 18 Type: `path` |
| kkonganti@92 | 19 |
| kkonganti@92 | 20 Takes in NextFlow input type of `path` which points to many log files that **MultiQC** should parse. |
| kkonganti@92 | 21 |
| kkonganti@92 | 22 Ex: |
| kkonganti@92 | 23 |
| kkonganti@92 | 24 ```groovy |
| kkonganti@92 | 25 [ '/data/sample1/centrifuge/cent_output.txt', '/data/sample1/kraken/kraken_output.txt'] ] |
| kkonganti@92 | 26 ``` |
| kkonganti@92 | 27 |
| kkonganti@92 | 28 \ |
| kkonganti@92 | 29 |
| kkonganti@92 | 30 |
| kkonganti@92 | 31 ### `output:` |
| kkonganti@92 | 32 |
| kkonganti@92 | 33 ___ |
| kkonganti@92 | 34 |
| kkonganti@92 | 35 #### `report` |
| kkonganti@92 | 36 |
| kkonganti@92 | 37 Type: `path` |
| kkonganti@92 | 38 |
| kkonganti@92 | 39 Outputs a NextFlow output type of `path` pointing to the location of **MultiQC** final HTML report. |
| kkonganti@92 | 40 |
| kkonganti@92 | 41 \ |
| kkonganti@92 | 42 |
| kkonganti@92 | 43 |
| kkonganti@92 | 44 #### `data` |
| kkonganti@92 | 45 |
| kkonganti@92 | 46 Type: `path` |
| kkonganti@92 | 47 |
| kkonganti@92 | 48 NextFlow output type of `path` pointing to the data files folder generated by **MultiQC** which were used to generate plots and HTML report. |
| kkonganti@92 | 49 |
| kkonganti@92 | 50 \ |
| kkonganti@92 | 51 |
| kkonganti@92 | 52 |
| kkonganti@92 | 53 #### `plots` |
| kkonganti@92 | 54 |
| kkonganti@92 | 55 Type: `path` |
| kkonganti@92 | 56 Optional: `true` |
| kkonganti@92 | 57 |
| kkonganti@92 | 58 NextFlow output type of `path` pointing to the plots folder generated by **MultiQC**. |
| kkonganti@92 | 59 |
| kkonganti@92 | 60 \ |
| kkonganti@92 | 61 |
| kkonganti@92 | 62 |
| kkonganti@92 | 63 #### `versions` |
| kkonganti@92 | 64 |
| kkonganti@92 | 65 Type: `path` |
| kkonganti@92 | 66 |
| kkonganti@92 | 67 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |