comparison 0.3.0/lib/help/spades.nf @ 92:295c2597a475

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