annotate 0.2.0/lib/help/checkm2predict.nf @ 0:9e8b1c747a6a draft default tip

planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:32:17 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
1 // Help text for checkm2 predict within CPIPES.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
2
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
3 def checkm2predictHelp(params) {
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
4
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
5 Map tool = [:]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
6 Map toolspecs = [:]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
7 tool.text = [:]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
8 tool.helpparams = [:]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
9
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
10 toolspecs = [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
11 'checkm2predict_run': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run `checkm2 predict` tool. Default: ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
13 (params.checkm2predict_run ?: false),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
16 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
17 'checkm2predict_quiet': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'Only output errors. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
19 "Default: ${params.checkm2predict_quiet}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: '--quiet',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: (params.checkm2predict_quiet ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
22 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
23 'checkm2predict_lowmem': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Low memory mode. Reduces DIAMOND blocksize to ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
25 'significantly reduce RAM usage at the expense of longer runtime. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
26 "Default: ${params.checkm2predict_lowmem}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
27 cliflag: '--lowmem',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
28 clivalue: (params.checkm2predict_lowmem ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
29 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
30 'checkm2predict_general': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
31 clihelp: 'Force the use of the general quality prediction model (gradient boost). ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
32 "Default: ${params.checkm2predict_general}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
33 cliflag: '--general',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
34 clivalue: (params.checkm2predict_general ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
35 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
36 'checkm2predict_specific': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
37 clihelp: "Force the use of the specific quality prediction model (neural network) " +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
38 "Default: ${params.checkm2predict_specific}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
39 cliflag: '--specific',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
40 clivalue: (params.checkm2predict_specific ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
41 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
42 'checkm2predict_allmodels': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
43 clihelp: 'Output quality prediction for both models for each genome. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
44 "Default: ${params.checkm2predict_allmodels}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
45 cliflag: '--allmodels',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
46 clivalue: (params.checkm2predict_allmodels ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
47 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
48 'checkm2predict_genes': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
49 clihelp: 'Treat input files as protein files. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
50 "Default: ${params.checkm2predict_genes}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
51 cliflag: '--genes',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
52 clivalue: (params.checkm2predict_genes ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
53 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
54 'checkm2predict_x': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
55 clihelp: 'Extension of input files. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
56 "Default: ${params.checkm2predict_x}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
57 cliflag: '-x',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
58 clivalue: (params.checkm2predict_x ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
59 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
60 'checkm2predict_tmpdir': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
61 clihelp: 'Specify an alternate directory for temporary files. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
62 "Default: ${params.checkm2predict_tmpdir}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
63 cliflag: '--tmpdir',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
64 clivalue: (params.checkm2predict_tmpdir ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
65 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
66 'checkm2predict_rminterfiles': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
67 clihelp: 'Remove all intermediate files (protein files, diamond output). ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
68 "Default: ${params.checkm2predict_rminterfiles}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
69 cliflag: '--remove_intermediates',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
70 clivalue: (params.checkm2predict_rminterfiles ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
71 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
72 'checkm2predict_ttable': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
73 clihelp: 'Provide a specific progidal translation table for bins. The default ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
74 'value of false will automatically determine either 11 or 4. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
75 "Default: ${params.checkm2predict_ttable}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
76 cliflag: '--ttable',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
77 clivalue: (params.checkm2predict_ttable ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
78 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
79 'checkm2predict_dbg_cos': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
80 clihelp: 'DEBUG: Write cosine similarity values to a file. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
81 "Default: ${params.checkm2predict_dbg_cos}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
82 cliflag: '--dbg_cos',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
83 clivalue: (params.checkm2predict_dbg_cos ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
84 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
85 'checkm2predict_dbg_vectors': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
86 clihelp: 'DEBUG: Write Dump pickled feature vectors to a file. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
87 "Default: ${params.checkm2predict_dbg_vectors}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
88 cliflag: '--dbg_vectors',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
89 clivalue: (params.checkm2predict_dbg_vectors ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
90 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
91 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
92
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
93 toolspecs.each {
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
94 k, v -> tool.text['--' + k] = "${v.clihelp}"
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
95 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
96 }
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
97
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
98 return tool
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
99 }