Mercurial > repos > galaxytrakr > hfp_cronology_awsbatch

comparison 0.2.0/lib/help/sourmashsearch.nf @ 0:9e8b1c747a6a draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:32:17 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:9e8b1c747a6a
1 // Help text for sourmash search within CPIPES.
2
3 def sourmashsearchHelp(params) {
4
5 Map tool = [:]
6 Map toolspecs = [:]
7 tool.text = [:]
8 tool.helpparams = [:]
9
10 toolspecs = [
11 'sourmashsearch_run': [
12 clihelp: 'Run `sourmash search` tool. Default: ' +
13 (params.sourmashsearch_run ?: false),
14 cliflag: null,
15 clivalue: null
16 ],
17 'sourmashsearch_n': [
18 clihelp: 'Number of results to report. ' +
19 'By default, will terminate at --sourmashsearch_thr value. ' +
20 "Default: ${params.sourmashsearch_n}",
21 cliflag: '-n',
22 clivalue: (params.sourmashsearch_n ?: '')
23 ],
24 'sourmashsearch_thr': [
25 clihelp: 'Reporting threshold (similarity) to return results. ' +
26 "Default: ${params.sourmashsearch_thr}",
27 cliflag: '--threshold',
28 clivalue: (params.sourmashsearch_thr ?: '')
29 ],
30 'sourmashsearch_contain': [
31 clihelp: 'Score based on containment rather than similarity. ' +
32 "Default: ${params.sourmashsearch_contain}",
33 cliflag: '--containment',
34 clivalue: (params.sourmashsearch_contain ? ' ' : '')
35 ],
36 'sourmashsearch_maxcontain': [
37 clihelp: 'Score based on max containment rather than similarity. ' +
38 "Default: ${params.sourmashsearch_contain}",
39 cliflag: '--max-containment',
40 clivalue: (params.sourmashsearch_maxcontain ? ' ' : '')
41 ],
42 'sourmashsearch_ignoreabn': [
43 clihelp: 'Do NOT use k-mer abundances if present. ' +
44 "Default: ${params.sourmashsearch_ignoreabn}",
45 cliflag: '--ignore-abundance',
46 clivalue: (params.sourmashsearch_ignoreabn ? ' ' : '')
47 ],
48 'sourmashsearch_ani_ci': [
49 clihelp: 'Output confidence intervals for ANI estimates. ' +
50 "Default: ${params.sourmashsearch_ani_ci}",
51 cliflag: '--estimate-ani-ci',
52 clivalue: (params.sourmashsearch_ani_ci ? ' ' : '')
53 ],
54 'sourmashsearch_k': [
55 clihelp: 'The k-mer size to select. ' +
56 "Default: ${params.sourmashsearch_k}",
57 cliflag: '-k',
58 clivalue: (params.sourmashsearch_k ?: '')
59 ],
60 'sourmashsearch_protein': [
61 clihelp: 'Choose a protein signature. ' +
62 "Default: ${params.sourmashsearch_protein}",
63 cliflag: '--protein',
64 clivalue: (params.sourmashsearch_protein ? ' ' : '')
65 ],
66 'sourmashsearch_noprotein': [
67 clihelp: 'Do not choose a protein signature. ' +
68 "Default: ${params.sourmashsearch_noprotein}",
69 cliflag: '--no-protein',
70 clivalue: (params.sourmashsearch_noprotein ? ' ' : '')
71 ],
72 'sourmashsearch_dayhoff': [
73 clihelp: 'Choose Dayhoff-encoded amino acid signatures. ' +
74 "Default: ${params.sourmashsearch_dayhoff}",
75 cliflag: '--dayhoff',
76 clivalue: (params.sourmashsearch_dayhoff ? ' ' : '')
77 ],
78 'sourmashsearch_nodayhoff': [
79 clihelp: 'Do not choose Dayhoff-encoded amino acid signatures. ' +
80 "Default: ${params.sourmashsearch_nodayhoff}",
81 cliflag: '--no-dayhoff',
82 clivalue: (params.sourmashsearch_nodayhoff ? ' ' : '')
83 ],
84 'sourmashsearch_hp': [
85 clihelp: 'Choose hydrophobic-polar-encoded amino acid signatures. ' +
86 "Default: ${params.sourmashsearch_hp}",
87 cliflag: '--hp',
88 clivalue: (params.sourmashsearch_hp ? ' ' : '')
89 ],
90 'sourmashsearch_nohp': [
91 clihelp: 'Do not choose hydrophobic-polar-encoded amino acid signatures. ' +
92 "Default: ${params.sourmashsearch_nohp}",
93 cliflag: '--no-hp',
94 clivalue: (params.sourmashsearch_nohp ? ' ' : '')
95 ],
96 'sourmashsearch_dna': [
97 clihelp: 'Choose DNA signature. ' +
98 "Default: ${params.sourmashsearch_dna}",
99 cliflag: '--dna',
100 clivalue: (params.sourmashsearch_dna ? ' ' : '')
101 ],
102 'sourmashsearch_nodna': [
103 clihelp: 'Do not choose DNA signature. ' +
104 "Default: ${params.sourmashsearch_nodna}",
105 cliflag: '--no-dna',
106 clivalue: (params.sourmashsearch_nodna ? ' ' : '')
107 ],
108 'sourmashsearch_scaled': [
109 clihelp: 'Scaled value should be between 100 and 1e6. ' +
110 "Default: ${params.sourmashsearch_scaled}",
111 cliflag: '--scaled',
112 clivalue: (params.sourmashsearch_scaled ?: '')
113 ],
114 'sourmashsearch_inc_pat': [
115 clihelp: 'Search only signatures that match this pattern in name, filename, or md5. ' +
116 "Default: ${params.sourmashsearch_inc_pat}",
117 cliflag: '--include-db-pattern',
118 clivalue: (params.sourmashsearch_inc_pat ?: '')
119 ],
120 'sourmashsearch_exc_pat': [
121 clihelp: 'Search only signatures that do not match this pattern in name, filename, or md5. ' +
122 "Default: ${params.sourmashsearch_exc_pat}",
123 cliflag: '--exclude-db-pattern',
124 clivalue: (params.sourmashsearch_exc_pat ?: '')
125 ]
126 ]
127
128 toolspecs.each {
129 k, v -> tool.text['--' + k] = "${v.clihelp}"
130 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
131 }
132
133 return tool
134 }