annotate 1.0.0/lib/help/kmaalign.nf @ 0:0a8dda29956e draft default tip

planemo upload
author galaxytrakr
date Thu, 28 May 2026 20:41:10 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
1 // Help text for kma align within CPIPES.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
2
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
3 def kmaalignHelp(params) {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
4
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
5 Map tool = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
6 Map toolspecs = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
7 tool.text = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
8 tool.helpparams = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
9
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
10 toolspecs = [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
11 'kmaalign_run': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run kma tool. Default: ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
13 (params.kmaalign_run ?: false),
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
16 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
17 'kmaalign_int': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'Input file has interleaved reads. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
19 " Default: ${params.kmaalign_int}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: '-int',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: (params.kmaalign_int ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
22 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
23 'kmaalign_ef': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Output additional features. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
25 "Default: ${params.kmaalign_ef}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: '-ef',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: (params.kmaalign_ef ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
28 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
29 'kmaalign_vcf': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: 'Output vcf file. 2 to apply FT. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
31 "Default: ${params.kmaalign_vcf}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: '-vcf',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: (params.kmaalign_vcf ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
34 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
35 'kmaalign_sam': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: 'Output SAM, 4/2096 for mapped/aligned. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
37 "Default: ${params.kmaalign_sam}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
38 cliflag: '-sam',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
39 clivalue: (params.kmaalign_sam ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
40 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
41 'kmaalign_nc': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
42 clihelp: 'No consensus file. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
43 "Default: ${params.kmaalign_nc}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
44 cliflag: '-nc',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
45 clivalue: (params.kmaalign_nc ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
46 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
47 'kmaalign_na': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
48 clihelp: 'No aln file. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
49 "Default: ${params.kmaalign_na}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
50 cliflag: '-na',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
51 clivalue: (params.kmaalign_na ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
52 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
53 'kmaalign_nf': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
54 clihelp: 'No frag file. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
55 "Default: ${params.kmaalign_nf}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
56 cliflag: '-nf',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
57 clivalue: (params.kmaalign_nf ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
58 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
59 'kmaalign_a': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
60 clihelp: 'Output all template mappings. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
61 "Default: ${params.kmaalign_a}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
62 cliflag: '-a',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
63 clivalue: (params.kmaalign_a ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
64 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
65 'kmaalign_and': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
66 clihelp: 'Use both -mrs and p-value on consensus. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
67 "Default: ${params.kmaalign_and}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
68 cliflag: '-and',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
69 clivalue: (params.kmaalign_and ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
70 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
71 'kmaalign_oa': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
72 clihelp: 'Use neither -mrs or p-value on consensus. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
73 "Default: ${params.kmaalign_oa}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
74 cliflag: '-oa',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
75 clivalue: (params.kmaalign_oa ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
76 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
77 'kmaalign_bc': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
78 clihelp: 'Minimum support to call bases. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
79 "Default: ${params.kmaalign_bc}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
80 cliflag: '-bc',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
81 clivalue: (params.kmaalign_bc ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
82 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
83 'kmaalign_bcNano': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
84 clihelp: 'Altered indel calling for ONT data. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
85 "Default: ${params.kmaalign_bcNano}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
86 cliflag: '-bcNano',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
87 clivalue: (params.kmaalign_bcNano ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
88 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
89 'kmaalign_bcd': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
90 clihelp: 'Minimum depth to call bases. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
91 "Default: ${params.kmaalign_bcd}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
92 cliflag: '-bcd',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
93 clivalue: (params.kmaalign_bcd ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
94 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
95 'kmaalign_bcg': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
96 clihelp: 'Maintain insignificant gaps. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
97 "Default: ${params.kmaalign_bcg}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
98 cliflag: '-bcg',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
99 clivalue: (params.kmaalign_bcg ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
100 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
101 'kmaalign_ID': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
102 clihelp: 'Minimum consensus ID. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
103 "Default: ${params.kmaalign_ID}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
104 cliflag: '-ID',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
105 clivalue: (params.kmaalign_ID ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
106 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
107 'kmaalign_md': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
108 clihelp: 'Minimum depth. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
109 "Default: ${params.kmaalign_md}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
110 cliflag: '-md',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
111 clivalue: (params.kmaalign_md ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
112 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
113 'kmaalign_dense': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
114 clihelp: 'Skip insertion in consensus. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
115 "Default: ${params.kmaalign_dense}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
116 cliflag: '-dense',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
117 clivalue: (params.kmaalign_dense ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
118 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
119 'kmaalign_ref_fsa': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
120 clihelp: 'Use Ns on indels. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
121 "Default: ${params.kmaalign_ref_fsa}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
122 cliflag: '-ref_fsa',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
123 clivalue: (params.kmaalign_ref_fsa ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
124 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
125 'kmaalign_Mt1': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
126 clihelp: 'Map everything to one template. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
127 "Default: ${params.kmaalign_Mt1}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
128 cliflag: '-Mt1',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
129 clivalue: (params.kmaalign_Mt1 ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
130 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
131 'kmaalign_1t1': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
132 clihelp: 'Map one query to one template. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
133 "Default: ${params.kmaalign_1t1}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
134 cliflag: '-1t1',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
135 clivalue: (params.kmaalign_1t1 ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
136 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
137 'kmaalign_mrs': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
138 clihelp: 'Minimum relative alignment score. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
139 "Default: ${params.kmaalign_mrs}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
140 cliflag: '-mrs',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
141 clivalue: (params.kmaalign_mrs ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
142 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
143 'kmaalign_mrc': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
144 clihelp: 'Minimum query coverage. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
145 "Default: ${params.kmaalign_mrc}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
146 cliflag: '-mrc',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
147 clivalue: (params.kmaalign_mrc ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
148 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
149 'kmaalign_mp': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
150 clihelp: 'Minimum phred score of trailing and leading bases. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
151 "Default: ${params.kmaalign_mp}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
152 cliflag: '-mp',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
153 clivalue: (params.kmaalign_mp ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
154 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
155 'kmaalign_mq': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
156 clihelp: 'Set the minimum mapping quality. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
157 "Default: ${params.kmaalign_mq}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
158 cliflag: '-mq',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
159 clivalue: (params.kmaalign_mq ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
160 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
161 'kmaalign_eq': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
162 clihelp: 'Minimum average quality score. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
163 "Default: ${params.kmaalign_eq}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
164 cliflag: '-eq',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
165 clivalue: (params.kmaalign_eq ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
166 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
167 'kmaalign_5p': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
168 clihelp: 'Trim 5 prime by this many bases. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
169 "Default: ${params.kmaalign_5p}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
170 cliflag: '-5p',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
171 clivalue: (params.kmaalign_5p ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
172 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
173 'kmaalign_3p': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
174 clihelp: 'Trim 3 prime by this many bases ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
175 "Default: ${params.kmaalign_3p}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
176 cliflag: '-3p',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
177 clivalue: (params.kmaalign_3p ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
178 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
179 'kmaalign_apm': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
180 clihelp: 'Sets both -pm and -fpm ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
181 "Default: ${params.kmaalign_apm}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
182 cliflag: '-apm',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
183 clivalue: (params.kmaalign_apm ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
184 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
185 'kmaalign_cge': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
186 clihelp: 'Set CGE penalties and rewards ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
187 "Default: ${params.kmaalign_cge}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
188 cliflag: '-cge',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
189 clivalue: (params.kmaalign_cge ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
190 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
191
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
192 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
193
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
194 toolspecs.each {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
195 k, v -> tool.text['--' + k] = "${v.clihelp}"
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
196 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
197 }
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
198
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
199 return tool
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
200 }