Mercurial > repos > kkonganti > cfsan_centriflaken

comparison 0.3.0/lib/help/megahit.nf @ 92:295c2597a475

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