Mercurial > repos > kkonganti > cfsan_bettercallsal
comparison 0.6.1/lib/help/wsnp.nf @ 11:749faef1caa9
"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 // Help text for waterfall_per_snp_cluster.pl (wsnp) within CPIPES. | |
2 | |
3 def wsnpHelp(params) { | |
4 | |
5 Map tool = [:] | |
6 Map toolspecs = [:] | |
7 tool.text = [:] | |
8 tool.helpparams = [:] | |
9 | |
10 toolspecs = [ | |
11 'wsnp_serocol': [ | |
12 clihelp: 'Column number (non 0-based index) of the PDG metadata file ' + | |
13 'by which the serotypes are collected.' + | |
14 " Default: ${params.wsnp_serocol}", | |
15 cliflag: '--serocol', | |
16 clivalue: (params.wsnp_serocol ?: '') | |
17 ], | |
18 'wsnp_complete_sero': [ | |
19 clihelp: 'Skip indexing serotypes when the serotype name in the column ' + | |
20 'number 49 (non 0-based) of PDG metadata file consists a "-". For example, if ' + | |
21 'an accession has a serotype= string as such in column ' + | |
22 'number 49 (non 0-based): ' + | |
23 '"serotype=- 13:z4,z23:-" ' + | |
24 'then, the indexing of that accession is skipped.' + | |
25 " Default: ${params.wsnp_complete_sero}", | |
26 cliflag: '--complete_serotype_name', | |
27 clivalue: (params.wsnp_complete_sero ? ' ' : '') | |
28 ], | |
29 'wsnp_not_null_serovar': [ | |
30 clihelp: 'Only index the computed_serotype column ' + | |
31 'i.e. column number 49 (non 0-based), if the serovar column' + | |
32 ' is not NULL. ' + | |
33 " Default: ${params.wsnp_not_null_serovar}", | |
34 cliflag: '--not_null_serotype_name', | |
35 clivalue: (params.wsnp_not_null_serovar ?: '') | |
36 ], | |
37 'wsnp_i': [ | |
38 clihelp: 'Force include this serovar. Ignores ' + | |
39 '--wsnp_complete_sero for only this serovar. ' + | |
40 'Mention multiple serovars separated by a ! (Exclamation mark). ' + | |
41 'Ex: --wsnp_complete_sero I 4,[5],12:i:-!Agona' + | |
42 " Default: ${params.wsnp_i}", | |
43 cliflag: '-i', | |
44 clivalue: (params.wsnp_i ? params.wsnp_i.split(/\!/).join(' -i ').trim().replace(/^\-i\s+/, '') : '') | |
45 ], | |
46 'wsnp_num': [ | |
47 clihelp: 'Number of genome accessions to collect per SNP cluster.' + | |
48 " Default: ${params.wsnp_num}", | |
49 cliflag: '-num', | |
50 clivalue: (params.wsnp_num ?: '') | |
51 ] | |
52 ] | |
53 | |
54 toolspecs.each { | |
55 k, v -> tool.text['--' + k] = "${v.clihelp}" | |
56 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ] | |
57 } | |
58 | |
59 return tool | |
60 } |