annotate 1.0.0/lib/help/megahit.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 megahit within CPIPES.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
2
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
3 def megahitHelp(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 'megahit_run': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run MEGAHIT assembler. Default: ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
13 (params.megahit_run ?: false),
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
16 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
17 'megahit_min_count': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: '<int>. Minimum multiplicity for filtering (k_min+1)-mers. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
19 "Default: ${params.megahit_min_count}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: '--min-count',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: (params.megahit_min_count ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
22 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
23 'megahit_k_list': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Comma-separated list of kmer size. All values must be odd, in ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
25 "the range 15-255, increment should be <= 28. Ex: '21,29,39,59,79,99,119,141'. " +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
26 "Default: ${params.megahit_k_list}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
27 cliflag: '--k-list',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
28 clivalue: (params.megahit_k_list ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
29 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
30 'megahit_no_mercy': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
31 clihelp: 'Do not add mercy k-mers. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
32 "Default: ${params.megahit_no_mercy}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
33 cliflag: '--no-mercy',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
34 clivalue: (params.megahit_no_mercy ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
35 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
36 'megahit_bubble_level': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
37 clihelp: '<int>. Intensity of bubble merging (0-2), 0 to disable. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
38 "Default: ${params.megahit_bubble_level}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
39 cliflag: '--bubble-level',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
40 clivalue: (params.megahit_bubble_level ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
41 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
42 'megahit_merge_level': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
43 clihelp: '<l,s>. Merge complex bubbles of length <= l*kmer_size and ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
44 "similarity >= s. Default: ${params.megahit_merge_level}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
45 cliflag: '--merge-level',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
46 clivalue: (params.megahit_merge_level ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
47 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
48 'megahit_prune_level': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
49 clihelp: '<int>. Strength of low depth pruning (0-3). ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
50 "Default: ${params.megahit_prune_level}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
51 cliflag: '--prune-level',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
52 clivalue: (params.megahit_prune_level ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
53 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
54 'megahit_prune_depth': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
55 clihelp: '<int>. Remove unitigs with avg k-mer depth less than this value. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
56 "Default: ${params.megahit_prune_depth}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
57 cliflag: '--prune-depth',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
58 clivalue: (params.megahit_prune_depth ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
59 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
60 'megahit_low_local_ratio': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
61 clihelp: '<float>. Ratio threshold to define low local coverage contigs. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
62 "Default: ${params.megahit_low_local_ratio}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
63 cliflag: '--low-local-ratio',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
64 clivalue: (params.megahit_low_local_ratio ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
65 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
66 'megahit_max_tip_len': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
67 clihelp: '<int>. remove tips less than this value [<int> * k]. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
68 "Default: ${params.megahit_max_tip_len}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
69 cliflag: '--max-tip-len',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
70 clivalue: (params.megahit_max_tip_len ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
71 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
72 'megahit_no_local': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
73 clihelp: 'Disable local assembly. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
74 "Default: ${params.megahit_no_local}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
75 cliflag: '--no-local',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
76 clivalue: (params.megahit_no_local ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
77 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
78 'megahit_kmin_1pass': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
79 clihelp: 'Use 1pass mode to build SdBG of k_min. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
80 "Default: ${params.megahit_kmin_1pass}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
81 cliflag: '--kmin-1pass',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
82 clivalue: (params.megahit_kmin_1pass ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
83 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
84 'megahit_preset': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
85 clihelp: '<str>. Override a group of parameters. Valid values are '+
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
86 "meta-sensitive which enforces '--min-count 1 --k-list 21,29,39,49,...,129,141', " +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
87 'meta-large (large & complex metagenomes, like soil) which enforces ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
88 "'--k-min 27 --k-max 127 --k-step 10'. " +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
89 "Default: ${params.megahit_preset}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
90 cliflag: '--preset',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
91 clivalue: (params.megahit_preset ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
92 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
93 'megahit_mem_flag': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
94 clihelp: '<int>. SdBG builder memory mode. 0: minimum; 1: moderate; 2: use all memory specified. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
95 "Default: ${params.megahit_mem_flag}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
96 cliflag: '--mem-flag',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
97 clivalue: (params.megahit_mem_flag ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
98 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
99 'megahit_min_contig_len': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
100 clihelp: '<int>. Minimum length of contigs to output. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
101 "Default: ${params.megahit_min_contig_len}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
102 cliflag: '--use-gpu',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
103 clivalue: (params.megahit_min_contig_len ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
104 ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
105 ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
106
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
107 toolspecs.each {
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
108 k, v -> tool.text['--' + k] = "${v.clihelp}"
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
109 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
110 }
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
111
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
112 return tool
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
113 }