annotate 1.0.0/lib/help/centrifuge.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 centrifuge within CPIPES.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
2
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
3 def centrifugeHelp(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 'centrifuge_x': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: "Absolute path to centrifuge database. Default: ${params.centrifuge_x}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
13 cliflag: '-x',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
14 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
15 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
16 'centrifuge_save_unaligned': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
17 clihelp: 'Save SINGLE-END reads that did not align. For PAIRED-END' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
18 " reads, save read pairs that did not align concordantly. Default: ${params.centrifuge_save_unaligned}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
19 cliflag: null, // Handled in modules logic.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
20 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
21 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
22 'centrifuge_save_aligned': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
23 clihelp: 'Save SINGLE-END reads that aligned. For PAIRED-END' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
24 " reads, save read pairs that aligned concordantly. Default: ${params.centrifuge_save_aligned}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
25 cliflag: null, // Handled in modules logic.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
26 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
27 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
28 'centrifuge_out_fmt_sam': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
29 clihelp: "Centrifuge output should be in SAM. Default: ${params.centrifuge_save_aligned}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
30 cliflag: null, // Handled in modules logic.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
31 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
32 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
33 'centrifuge_extract_bug': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
34 clihelp: "Extract this bug from centrifuge results." +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
35 " Default: ${params.centrifuge_extract_bug}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
36 cliflag: null, // Handled in modules logic.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
37 clivalue: null,
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
38 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
39 'centrifuge_ignore_quals': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
40 clihelp: 'Treat all quality values as 30 on Phred scale. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
41 "Default: ${params.centrifuge_ignore_quals}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
42 cliflag: '--ignore-quals',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
43 clivalue: (params.centrifuge_ignore_quals ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
44 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
45 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
46
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
47 toolspecs.each {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
48 k, v -> tool.text['--' + k] = "${v.clihelp}"
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
49 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
50 }
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
51
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
52 return tool
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
53 }
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
54