annotate 0.2.0/lib/help/dpubmlstpy.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 dl_pubmlst_profiles_and_schemes.py (dpubmlstpy) within CPIPES.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
2
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
3 def dpubmlstpyHelp(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 'dpubmlstpy_run': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run the dl_pubmlst_profiles_and_schemes.py ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
13 'script. Default: ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
14 (params.dpubmlstpy_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 'dpubmlstpy_org': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
19 clihelp: 'The organism name to download the MLST alleles ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
20 'FASTA and profile CSV for. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
21 " Default: ${params.dpubmlstpy_org}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
22 cliflag: '-org',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
23 clivalue: (params.dpubmlstpy_org ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
24 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
25 'dpubmlstpy_mlsts': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
26 clihelp: 'The MLST scheme ID to download. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
27 " Default: ${params.dpubmlstpy_mlsts}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
28 cliflag: '-mlsts',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
29 clivalue: (params.dpubmlstpy_mlsts ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
30 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
31 'dpubmlstpy_profile': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
32 clihelp: 'The MLST profile name in the scheme. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
33 " Default: ${params.dpubmlstpy_profile}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
34 cliflag: '-profile',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
35 clivalue: (params.dpubmlstpy_profile ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
36 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
37 'dpubmlstpy_loci': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
38 clihelp: 'The key name in the JSON response which lists the ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
39 'allele URLs to download. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
40 " Default: ${params.dpubmlstpy_loci}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
41 cliflag: '-loci',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
42 clivalue: (params.dpubmlstpy_loci ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
43 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
44 'dpubmlstpy_suffix': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
45 clihelp: 'What should be the suffix of the downloaded allele ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
46 'FASTA. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
47 " Default: ${params.dpubmlstpy_suffix}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
48 cliflag: '-suffix',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
49 clivalue: (params.dpubmlstpy_suffix ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
50 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
51 'dpubmlstpy_akey': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
52 clihelp: 'What is the key in the JSON response that contains ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
53 'the URL for allele FASTA. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
54 " Default: ${params.dpubmlstpy_akey}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
55 cliflag: '-akey',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
56 clivalue: (params.dpubmlstpy_akey ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
57 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
58 'dpubmlstpy_id': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
59 clihelp: 'What is the key in the JSON response that contains ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
60 'the name of the allele FASTA. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
61 " Default: ${params.dpubmlstpy_id}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
62 cliflag: '-id',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
63 clivalue: (params.dpubmlstpy_id ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
64 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
65 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
66
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
67 toolspecs.each {
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
68 k, v -> tool.text['--' + k] = "${v.clihelp}"
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
69 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
70 }
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
71
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
72 return tool
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
73 }