annotate 0.2.0/lib/help/guncrun.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 gunc run within CPIPES.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
2
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
3 def guncrunHelp(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 'guncrun_run': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run `gunc run` tool. Default: ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
13 (params.guncrun_run ?: false),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
16 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
17 'guncrun_in_is_fasta': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'Is input a file in FASTA format. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
19 "Default: ${params.guncrun_in_is_fasta}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: null,
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: null
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
22 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
23 'guncrun_in_is_fofn': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Is input a file of file names. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
25 "Default: ${params.guncrun_in_is_fofn}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: null,
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: null
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
28 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
29 'guncrun_in_is_dir': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: 'Is input a directory of FASTA files. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
31 "Default: ${params.guncrun_in_is_dir}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: null,
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: null
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
34 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
35 'guncrun_file_suffix': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: "Suffix of files if input is a directory. " +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
37 "Default: ${params.guncrun_file_suffix}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
38 cliflag: '--file_suffix',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
39 clivalue: (params.guncrun_file_suffix ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
40 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
41 'guncrun_gene_calls': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
42 clihelp: 'Input files are in FASTA faa format. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
43 "Default: ${params.guncrun_gene_calls}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
44 cliflag: '--gene_calls',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
45 clivalue: (params.guncrun_gene_calls ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
46 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
47 'guncrun_temp_dir': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
48 clihelp: 'Path to directory to store temp files. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
49 "Default: ${params.guncrun_temp_dir}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
50 cliflag: '--temp_dir',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
51 clivalue: (params.guncrun_temp_dir ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
52 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
53 'guncrun_sensitive': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
54 clihelp: 'Run with high sensitivity. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
55 "Default: ${params.guncrun_sensitive}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
56 cliflag: '--sensitive',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
57 clivalue: (params.guncrun_sensitive ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
58 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
59 'guncrun_detailed_output': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
60 clihelp: 'Output scores for every taxa level. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
61 "Default: ${params.guncrun_detailed_output}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
62 cliflag: '--detailed_output',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
63 clivalue: (params.guncrun_detailed_output ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
64 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
65 'guncrun_ctg_tax_output': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
66 clihelp: 'Output assignments for each contig. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
67 "Default: ${params.guncrun_ctg_tax_output}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
68 cliflag: '--contig_taxonomy_output',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
69 clivalue: (params.guncrun_ctg_tax_output ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
70 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
71 'guncrun_use_species_lvl': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
72 clihelp: 'Allow species level to be picked as maxCSS. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
73 "Default: ${params.guncrun_use_species_lvl}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
74 cliflag: '--use_species_level',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
75 clivalue: (params.guncrun_use_species_lvl ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
76 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
77 'guncrun_min_mapped_genes': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
78 clihelp: 'Do not calculate GUNC score if number of mapped ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
79 'genes is below this value. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
80 "Default: ${params.guncrun_min_mapped_genes}",
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
81 cliflag: '--min_mapped_genes',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
82 clivalue: (params.guncrun_min_mapped_genes ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
83 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
84 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
85
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
86 toolspecs.each {
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
87 k, v -> tool.text['--' + k] = "${v.clihelp}"
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
88 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
89 }
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
90
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
91 return tool
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
92 }