annotate 1.0.0/lib/help/tuspy.nf @ 0:0a8dda29956e draft default tip

planemo upload
author galaxytrakr
date Thu, 28 May 2026 20:41:10 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
1 // Help text for get_top_unique_mash_hit_genomes.py (tuspy) within CPIPES.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
2
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
3 def tuspyHelp(params) {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
4
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
5 Map tool = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
6 Map toolspecs = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
7 tool.text = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
8 tool.helpparams = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
9
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
10 toolspecs = [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
11 'tuspy_run': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run the get_top_unique_mash_hits_genomes.py ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
13 'script. Default: ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
14 (params.tuspy_run ?: false),
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
15 cliflag: null,
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
16 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
17 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
18 'tuspy_s': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
19 clihelp: 'Absolute UNIX path to metadata text file with the ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
20 'field separator, | and ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
21 '5 fields: serotype|asm_lvl|asm_url|snp_cluster_id' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
22 'Ex: serotype=Derby,antigen_formula=4:f,g:-|Scaffold|402440|ftp://...' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
23 '|PDS000096654.2. Mentioning this option will create a pickle file for the ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
24 'provided metadata and exits.' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
25 " Default: ${params.tuspy_s}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: '-s',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: (params.tuspy_s ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
28 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
29 'tuspy_m': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: 'Absolute UNIX path to mash screen results file.' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
31 " Default: ${params.tuspy_m}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: '-m',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: (params.tuspy_m ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
34 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
35 'tuspy_ps': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: 'Absolute UNIX Path to serialized metadata object ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
37 'in a pickle file.' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
38 " Default: ${params.tuspy_ps}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
39 cliflag: '-ps',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
40 clivalue: (params.tuspy_ps ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
41 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
42 'tuspy_gd': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
43 clihelp: 'Absolute UNIX Path to directory containing ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
44 'gzipped genome FASTA files.' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
45 " Default: ${params.tuspy_gd}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
46 cliflag: '-gd',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
47 clivalue: (params.tuspy_gd ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
48 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
49 'tuspy_gds': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
50 clihelp: 'Genome FASTA file suffix to search for in the ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
51 'genome directory.' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
52 " Default: ${params.tuspy_gds}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
53 cliflag: '-gds',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
54 clivalue: (params.tuspy_gds ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
55 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
56 'tuspy_n': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
57 clihelp: 'Return up to this many number of top N unique ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
58 'genome accession hits.' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
59 " Default: ${params.tuspy_n}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
60 cliflag: '-n',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
61 clivalue: (params.tuspy_n ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
62 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
63 'tuspy_skip': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
64 clihelp: 'Skip all hits which belong to the following bioproject ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
65 'accession(s). A comma separated list of more than one bioproject. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
66 " Default: ${params.tuspy_skip}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
67 cliflag: '-skip',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
68 clivalue: (params.tuspy_skip ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
69 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
70 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
71
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
72 toolspecs.each {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
73 k, v -> tool.text['--' + k] = "${v.clihelp}"
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
74 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
75 }
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
76
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
77 return tool
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
78 }