Mercurial > repos > kkonganti > hfp_nowayout

comparison 0.5.0/lib/help/sourmashsketch.nf @ 0:97cd2f532efe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload
author kkonganti
date Mon, 31 Mar 2025 14:50:40 -0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:97cd2f532efe
1 // Help text for sourmash sketch dna within CPIPES.
2
3 def sourmashsketchHelp(params) {
4
5 Map tool = [:]
6 Map toolspecs = [:]
7 tool.text = [:]
8 tool.helpparams = [:]
9
10 toolspecs = [
11 'sourmashsketch_run': [
12 clihelp: 'Run `sourmash sketch dna` tool. Default: ' +
13 (params.sourmashsketch_run ?: false),
14 cliflag: null,
15 clivalue: null
16 ],
17 'sourmashsketch_mode': [
18 clihelp: "Select which type of signatures to be created: dna, protein, fromfile or translate. "
19 + "Default: ${params.sourmashsketch_mode}",
20 cliflag: "${params.sourmashsketch_mode}",
21 clivalue: ' '
22 ],
23 'sourmashsketch_p': [
24 clihelp: 'Signature parameters to use. ' +
25 "Default: ${params.sourmashsketch_p}",
26 cliflag: '-p',
27 clivalue: (params.sourmashsketch_p ?: '')
28 ],
29 'sourmashsketch_file': [
30 clihelp: '<path> A text file containing a list of sequence files to load. ' +
31 "Default: ${params.sourmashsketch_file}",
32 cliflag: '--from-file',
33 clivalue: (params.sourmashsketch_file ?: '')
34 ],
35 'sourmashsketch_f': [
36 clihelp: 'Recompute signatures even if the file exists. ' +
37 "Default: ${params.sourmashsketch_f}",
38 cliflag: '-f',
39 clivalue: (params.sourmashsketch_f ? ' ' : '')
40 ],
41 'sourmashsketch_name': [
42 clihelp: 'Name the signature generated from each file after the first record in the file. ' +
43 "Default: ${params.sourmashsketch_name}",
44 cliflag: '--name-from-first',
45 clivalue: (params.sourmashsketch_name ? ' ' : '')
46 ],
47 'sourmashsketch_randomize': [
48 clihelp: 'Shuffle the list of input files randomly. ' +
49 "Default: ${params.sourmashsketch_randomize}",
50 cliflag: '--randomize',
51 clivalue: (params.sourmashsketch_randomize ? ' ' : '')
52 ]
53 ]
54
55 toolspecs.each {
56 k, v -> tool.text['--' + k] = "${v.clihelp}"
57 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
58 }
59
60 return tool
61 }