Mercurial > repos > kkonganti > hfp_nowayout
annotate 0.5.0/modules/custom/dump_software_versions/README.md @ 0:97cd2f532efe
planemo upload
| author | kkonganti |
|---|---|
| date | Mon, 31 Mar 2025 14:50:40 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| kkonganti@0 | 1 # NextFlow DSL2 Module |
| kkonganti@0 | 2 |
| kkonganti@0 | 3 ```bash |
| kkonganti@0 | 4 DUMP_SOFTWARE_VERSIONS |
| kkonganti@0 | 5 ``` |
| kkonganti@0 | 6 |
| kkonganti@0 | 7 ## Description |
| kkonganti@0 | 8 |
| kkonganti@0 | 9 Given an `YAML` format file, produce a final `.yml` file which has unique entries and a corresponding `.mqc.yml` file for use with `multiqc`. |
| kkonganti@0 | 10 |
| kkonganti@0 | 11 \ |
| kkonganti@0 | 12 |
| kkonganti@0 | 13 |
| kkonganti@0 | 14 ### `input:` |
| kkonganti@0 | 15 |
| kkonganti@0 | 16 ___ |
| kkonganti@0 | 17 |
| kkonganti@0 | 18 Type: `path` |
| kkonganti@0 | 19 |
| kkonganti@0 | 20 Takes in a `path` (`versions`) type pointing to the file to be used to produce a final `.yml` file without any duplicate entries and a `.mqc.yml` file. Generally, this is passed by mixing `versions` from various run time channels and finally passed to this module to produce a final software versions list. |
| kkonganti@0 | 21 |
| kkonganti@0 | 22 Ex: |
| kkonganti@0 | 23 |
| kkonganti@0 | 24 ```groovy |
| kkonganti@0 | 25 [ '/hpc/scratch/test/work/9b/e7bf7e28806419c1c9a571dacd1f67/versions.yml' ] |
| kkonganti@0 | 26 ``` |
| kkonganti@0 | 27 |
| kkonganti@0 | 28 \ |
| kkonganti@0 | 29 |
| kkonganti@0 | 30 |
| kkonganti@0 | 31 ### `output:` |
| kkonganti@0 | 32 |
| kkonganti@0 | 33 ___ |
| kkonganti@0 | 34 |
| kkonganti@0 | 35 #### `yml` |
| kkonganti@0 | 36 |
| kkonganti@0 | 37 Type: `path` |
| kkonganti@0 | 38 |
| kkonganti@0 | 39 NextFlow output type of `path` type pointing to an `YAML` file with software versions. |
| kkonganti@0 | 40 |
| kkonganti@0 | 41 \ |
| kkonganti@0 | 42 |
| kkonganti@0 | 43 |
| kkonganti@0 | 44 #### `mqc_yml` |
| kkonganti@0 | 45 |
| kkonganti@0 | 46 Type: `path` |
| kkonganti@0 | 47 |
| kkonganti@0 | 48 NextFlow output type of `path` pointing to `.mqc.yml` file which can be used to produce a software versions' table with `multiqc`. |
| kkonganti@0 | 49 |
| kkonganti@0 | 50 \ |
| kkonganti@0 | 51 |
| kkonganti@0 | 52 |
| kkonganti@0 | 53 #### `versions` |
| kkonganti@0 | 54 |
| kkonganti@0 | 55 Type: `path` |
| kkonganti@0 | 56 |
| kkonganti@0 | 57 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process. |