annotate 1.0.0/lib/help/wcomp.nf @ 0:801b85b03a17 draft default tip

planemo upload
author galaxytrakr
date Thu, 28 May 2026 20:31:42 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
1 // Help text for waterfall_per_computed_serotype.pl (wcomp) within CPIPES.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
2
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
3 def wcompHelp(params) {
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
4
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
5 Map tool = [:]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
6 Map toolspecs = [:]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
7 tool.text = [:]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
8 tool.helpparams = [:]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
9
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
10 toolspecs = [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
11 'wcomp_serocol': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Column number (non 0-based index) of the PDG metadata file ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
13 'by which the serotypes are collected.' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
14 " Default: ${params.wcomp_serocol}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
15 cliflag: '--serocol',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
16 clivalue: (params.wcomp_serocol ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
17 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
18 'wcomp_seronamecol': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
19 clihelp: 'Column number (non 0-based index) of the PDG metadata file whose column ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
20 'name is "serovar". ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
21 " Default: ${params.wcomp_seronamecol}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
22 cliflag: '--seronamecol',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
23 clivalue: (params.wcomp_seronamecol ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
24 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
25 'wcomp_acc_col': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
26 clihelp: 'Column number (non 0-based index) of the PDG metadata file whose column ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
27 'name is "acc". ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
28 " Default: ${params.wcomp_seronamecol}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
29 cliflag: '--acc_col',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
30 clivalue: (params.wcomp_acc_col ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
31 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
32 'wcomp_target_acc_col': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
33 clihelp: 'Column number (non 0-based index) of the PDG metadata file whose column ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
34 'name is "target_acc". ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
35 " Default: ${params.wcomp_seronamecol}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
36 cliflag: '--target_acc_col',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
37 clivalue: (params.wcomp_target_acc_col ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
38 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
39 'wcomp_complete_sero': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
40 clihelp: 'Skip indexing serotypes when the serotype name in the column ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
41 'number 49 (non 0-based) of PDG metadata file consists a "-". For example, if ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
42 'an accession has a serotype= string as such in column ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
43 'number 49 (non 0-based): ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
44 '"serotype=- 13:z4,z23:-" ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
45 'then, the indexing of that accession is skipped.' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
46 " Default: ${params.wcomp_complete_sero}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
47 cliflag: '--complete_serotype_name',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
48 clivalue: (params.wcomp_complete_sero ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
49 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
50 'wcomp_not_null_serovar': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
51 clihelp: 'Only index the computed_serotype column ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
52 'i.e. column number 49 (non 0-based), if the serovar column' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
53 ' is not NULL. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
54 " Default: ${params.wcomp_not_null_serovar}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
55 cliflag: '--not_null_serotype_name',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
56 clivalue: (params.wcomp_not_null_serovar ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
57 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
58 'wcomp_i': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
59 clihelp: 'Force include this serovar. Ignores ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
60 '--wcomp_complete_sero for only this serovar. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
61 'Mention multiple serovars separated by a ! (Exclamation mark). ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
62 'Ex: --wcomp_complete_sero I 4,[5],12:i:-!Agona' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
63 " Default: ${params.wcomp_i}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
64 cliflag: '-i',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
65 clivalue: (params.wcomp_i ? params.wcomp_i.split(/\!/).join(' -i ').trim().replace(/^\-i\s+/, '') : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
66 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
67 'wcomp_num': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
68 clihelp: 'Number of genome accessions to be collected per serotype.' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
69 " Default: ${params.wcomp_num}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
70 cliflag: '-num',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
71 clivalue: (params.wcomp_num ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
72 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
73 'wcomp_min_contig_size': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
74 clihelp: 'Minimum contig size to consider a genome for indexing.' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
75 " Default: ${params.wcomp_min_contig_size}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
76 cliflag: '--min_contig_size',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
77 clivalue: (params.wcomp_min_contig_size ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
78 ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
79 ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
80
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
81 toolspecs.each {
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
82 k, v -> tool.text['--' + k] = "${v.clihelp}"
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
83 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
84 }
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
85
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
86 return tool
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
87 }