annotate 1.0.0/lib/help/sourmashsigkmers.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 sourmash sigkmers within CPIPES.
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
2
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
3 def sourmashsigkmersHelp(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 'sourmashsigkmers_run': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run `sourmash sigkmers` tool. Default: ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
13 (params.sourmashsigkmers_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 'sourmashsigkmers_k': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'The k-mer size to select. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
19 "Default: ${params.sourmashsigkmers_k}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: '-k',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: (params.sourmashsigkmers_k ?: '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
22 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
23 'sourmashsigkmers_protein': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Choose a protein signature. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
25 "Default: ${params.sourmashsigkmers_protein}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: '--protein',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: (params.sourmashsigkmers_protein ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
28 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
29 'sourmashsigkmers_noprotein': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: 'Do not choose a protein signature. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
31 "Default: ${params.sourmashsigkmers_noprotein}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: '--no-protein',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: (params.sourmashsigkmers_noprotein ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
34 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
35 'sourmashsigkmers_dayhoff': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: 'Choose Dayhoff-encoded amino acid signatures. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
37 "Default: ${params.sourmashsigkmers_dayhoff}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
38 cliflag: '--dayhoff',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
39 clivalue: (params.sourmashsigkmers_dayhoff ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
40 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
41 'sourmashsigkmers_nodayhoff': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
42 clihelp: 'Do not choose Dayhoff-encoded amino acid signatures. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
43 "Default: ${params.sourmashsigkmers_nodayhoff}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
44 cliflag: '--no-dayhoff',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
45 clivalue: (params.sourmashsigkmers_nodayhoff ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
46 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
47 'sourmashsigkmers_hp': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
48 clihelp: 'Choose hydrophobic-polar-encoded amino acid signatures. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
49 "Default: ${params.sourmashsigkmers_hp}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
50 cliflag: '--hp',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
51 clivalue: (params.sourmashsigkmers_hp ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
52 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
53 'sourmashsigkmers_nohp': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
54 clihelp: 'Do not choose hydrophobic-polar-encoded amino acid signatures. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
55 "Default: ${params.sourmashsigkmers_nohp}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
56 cliflag: '--no-hp',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
57 clivalue: (params.sourmashsigkmers_nohp ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
58 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
59 'sourmashsigkmers_dna': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
60 clihelp: 'Choose DNA signature. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
61 "Default: ${params.sourmashsigkmers_dna}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
62 cliflag: '--dna',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
63 clivalue: (params.sourmashsigkmers_dna ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
64 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
65 'sourmashsigkmers_nodna': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
66 clihelp: 'Do not choose DNA signature. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
67 "Default: ${params.sourmashsigkmers_nodna}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
68 cliflag: '--no-dna',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
69 clivalue: (params.sourmashsigkmers_nodna ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
70 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
71 'sourmashsigkmers_save_kmers': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
72 clihelp: 'Save k-mers and hash values to a CSV file. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
73 "Default: ${params.sourmashsigkmers_save_kmers}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
74 cliflag: null,
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
75 clivalue: null
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
76 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
77 'sourmashsigkmers_save_seqs': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
78 clihelp: 'Save sequences with matching hash values to a FASTA file. ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
79 "Default: ${params.sourmashsigkmers_save_seqs}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
80 cliflag: null,
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
81 clivalue: null
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
82 ],
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
83 'sourmashsigkmers_translate': [
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
84 clihelp: 'Translate DNA k-mers into amino acids (for protein, dayhoff, and hp sketches). ' +
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
85 "Default: ${params.sourmashsigkmers_translate}",
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
86 cliflag: '--translate',
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
87 clivalue: (params.sourmashsigkmers_translate ? ' ' : '')
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
88 ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
89 ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
90
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
91 toolspecs.each {
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
92 k, v -> tool.text['--' + k] = "${v.clihelp}"
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
93 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
94 }
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
95
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
96 return tool
801b85b03a17 planemo upload
galaxytrakr
parents:
diff changeset
97 }