annotate 1.0.0/lib/help/spades.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 spades within CPIPES.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
2
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
3 def spadesHelp(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 'spades_run': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run SPAdes assembler. Default: ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
13 (params.spades_run ?: false),
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
16 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
17 'spades_isolate': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'This flag is highly recommended for high-coverage isolate and ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
19 "multi-cell data. Default: ${params.spades_isolate}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: '--isolate',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: (params.spades_isolate ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
22 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
23 'spades_sc': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'This flag is required for MDA (single-cell) data. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
25 "Default: ${params.spades_sc}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: '--sc',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: (params.spades_sc ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
28 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
29 'spades_meta': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: 'This flag is required for metagenomic data. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
31 "Default: ${params.spades_meta}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: '--meta',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: (params.spades_meta ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
34 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
35 'spades_bio': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: 'This flag is required for biosytheticSPAdes mode. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
37 "Default: ${params.spades_bio}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
38 cliflag: '--bio',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
39 clivalue: (params.spades_bio ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
40 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
41 'spades_corona': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
42 clihelp: 'This flag is required for coronaSPAdes mode. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
43 "Default: ${params.spades_corona}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
44 cliflag: '--corona',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
45 clivalue: (params.spades_corona ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
46 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
47 'spades_rna': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
48 clihelp: 'This flag is required for RNA-Seq data. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
49 "Default: ${params.spades_rna}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
50 cliflag: '--rna',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
51 clivalue: (params.spades_rna ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
52 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
53 'spades_plasmid': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
54 clihelp: 'Runs plasmidSPAdes pipeline for plasmid detection. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
55 "Default: ${params.spades_plasmid}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
56 cliflag: '--plasmid',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
57 clivalue: (params.spades_plasmid ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
58 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
59 'spades_metaviral': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
60 clihelp: 'Runs metaviralSPAdes pipeline for virus detection. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
61 "Default: ${params.spades_metaviral}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
62 cliflag: '--metaviral',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
63 clivalue: (params.spades_metaviral ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
64 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
65 'spades_metaplasmid': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
66 clihelp: 'Runs metaplasmidSPAdes pipeline for plasmid detection in ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
67 "metagenomics datasets. Default: ${params.spades_metaplasmid}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
68 cliflag: '--metaplasmid',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
69 clivalue: (params.spades_metaplasmid ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
70 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
71 'spades_rnaviral': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
72 clihelp: 'This flag enables virus assembly module from RNA-Seq data. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
73 "Default: ${params.spades_rnaviral}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
74 cliflag: '--rnaviral',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
75 clivalue: (params.spades_rnaviral ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
76 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
77 'spades_iontorrent': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
78 clihelp: 'This flag is required for IonTorrent data. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
79 "Default: ${params.spades_iontorrent}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
80 cliflag: '--iontorrent',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
81 clivalue: (params.spades_iontorrent ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
82 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
83 'spades_only_assembler': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
84 clihelp: 'Runs only the SPAdes assembler module (without read error correction). ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
85 "Default: ${params.spades_only_assembler}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
86 cliflag: '--only-assembler',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
87 clivalue: (params.spades_only_assembler ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
88 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
89 'spades_careful': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
90 clihelp: 'Tries to reduce the number of mismatches and short indels in the assembly. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
91 "Default: ${params.spades_careful}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
92 cliflag: '--careful',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
93 clivalue: (params.spades_careful ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
94 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
95 'spades_cov_cutoff': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
96 clihelp: 'Coverage cutoff value (a positive float number). ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
97 "Default: ${params.spades_cov_cutoff}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
98 cliflag: '--cov-cutoff',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
99 clivalue: (params.spades_cov_cutoff ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
100 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
101 'spades_k': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
102 clihelp: 'List of k-mer sizes (must be odd and less than 128). ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
103 "Default: ${params.spades_k}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
104 cliflag: '-k',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
105 clivalue: (params.spades_k ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
106 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
107 'spades_hmm': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
108 clihelp: 'Directory with custom hmms that replace the default ones (very rare). ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
109 "Default: ${params.spades_hmm}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
110 cliflag: '--custom-hmms',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
111 clivalue: (params.spades_hmm ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
112 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
113 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
114
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
115 toolspecs.each {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
116 k, v -> tool.text['--' + k] = "${v.clihelp}"
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
117 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
118 }
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
119
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
120 return tool
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
121 }