annotate 0.2.0/lib/help/tuspy.nf @ 0:9e8b1c747a6a draft default tip

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