annotate 0.5.0/lib/help/sourmashsketch.nf @ 0:3c767f9cfd88 draft default tip

planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:37:56 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
1 // Help text for sourmash sketch dna within CPIPES.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
2
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
3 def sourmashsketchHelp(params) {
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
4
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
5 Map tool = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
6 Map toolspecs = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
7 tool.text = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
8 tool.helpparams = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
9
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
10 toolspecs = [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
11 'sourmashsketch_run': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run `sourmash sketch dna` tool. Default: ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
13 (params.sourmashsketch_run ?: false),
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
16 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
17 'sourmashsketch_mode': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: "Select which type of signatures to be created: dna, protein, fromfile or translate. "
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
19 + "Default: ${params.sourmashsketch_mode}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: "${params.sourmashsketch_mode}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: ' '
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
22 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
23 'sourmashsketch_p': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Signature parameters to use. ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
25 "Default: ${params.sourmashsketch_p}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: '-p',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: (params.sourmashsketch_p ?: '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
28 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
29 'sourmashsketch_file': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: '<path> A text file containing a list of sequence files to load. ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
31 "Default: ${params.sourmashsketch_file}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: '--from-file',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: (params.sourmashsketch_file ?: '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
34 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
35 'sourmashsketch_f': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: 'Recompute signatures even if the file exists. ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
37 "Default: ${params.sourmashsketch_f}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
38 cliflag: '-f',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
39 clivalue: (params.sourmashsketch_f ? ' ' : '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
40 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
41 'sourmashsketch_name': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
42 clihelp: 'Name the signature generated from each file after the first record in the file. ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
43 "Default: ${params.sourmashsketch_name}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
44 cliflag: '--name-from-first',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
45 clivalue: (params.sourmashsketch_name ? ' ' : '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
46 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
47 'sourmashsketch_randomize': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
48 clihelp: 'Shuffle the list of input files randomly. ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
49 "Default: ${params.sourmashsketch_randomize}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
50 cliflag: '--randomize',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
51 clivalue: (params.sourmashsketch_randomize ? ' ' : '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
52 ]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
53 ]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
54
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
55 toolspecs.each {
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
56 k, v -> tool.text['--' + k] = "${v.clihelp}"
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
57 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
58 }
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
59
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
60 return tool
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
61 }