Mercurial > repos > kkonganti > cfsan_bettercallsal

comparison 0.6.1/modules/custom/dump_software_versions/README.md @ 11:749faef1caa9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload"
author kkonganti
date Tue, 05 Sep 2023 11:51:40 -0400
parents
children
comparison
equal deleted inserted replaced
10:1b9de878b04a 11:749faef1caa9
1 # NextFlow DSL2 Module
2
3 ```bash
4 DUMP_SOFTWARE_VERSIONS
5 ```
6
7 ## Description
8
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`.
10
11 \
12  
13
14 ### `input:`
15
16 ___
17
18 Type: `path`
19
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.
21
22 Ex:
23
24 ```groovy
25 [ '/hpc/scratch/test/work/9b/e7bf7e28806419c1c9a571dacd1f67/versions.yml' ]
26 ```
27
28 \
29  
30
31 ### `output:`
32
33 ___
34
35 #### `yml`
36
37 Type: `path`
38
39 NextFlow output type of `path` type pointing to an `YAML` file with software versions.
40
41 \
42  
43
44 #### `mqc_yml`
45
46 Type: `path`
47
48 NextFlow output type of `path` pointing to `.mqc.yml` file which can be used to produce a software versions' table with `multiqc`.
49
50 \
51  
52
53 #### `versions`
54
55 Type: `path`
56
57 NextFlow output type of `path` pointing to the `.yml` file storing software versions for this process.