annotate 1.0.0/lib/help/filtlong.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 filtlong within CPIPES.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
2
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
3 def filtlongHelp(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 'filtlong_run': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run filtlong read trimming tool. Default: ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
13 (params.filtlong_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 'filtlong_keep_perc': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'Keep only this percentage of best reads. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
19 "Default: ${params.filtlong_keep_perc}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: '--keep_percent',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: (params.filtlong_keep_perc ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
22 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
23 'filtlong_target_bases': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Keep only the best bases up to this many total bases. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
25 "Default: ${params.filtlong_target_bases}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: '--target_bases',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: (params.filtlong_target_bases ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
28 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
29 'filtlong_min_length': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: 'Minimum length threshold. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
31 "Default: ${params.filtlong_min_length}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: '--min_length',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: (params.filtlong_min_length ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
34 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
35 'filtlong_max_length': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: 'Maximum length threshold. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
37 "Default: ${params.filtlong_max_length}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
38 cliflag: '--max_length',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
39 clivalue: (params.filtlong_max_length ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
40 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
41 'filtlong_min_mean_q': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
42 clihelp: 'Minimum mean quality threshold. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
43 "Default: ${params.filtlong_min_mean_q}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
44 cliflag: '--min_mean_q',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
45 clivalue: (params.filtlong_min_mean_q ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
46 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
47 'filtlong_min_window_q': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
48 clihelp: 'Minimum window quality threshold. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
49 "Default: ${params.filtlong_min_window_q}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
50 cliflag: '--min_window_q',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
51 clivalue: (params.filtlong_min_window_q ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
52 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
53 'filtlong_a': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
54 clihelp: "External reference assembly in FASTA format. " +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
55 "Default: ${params.filtlong_a}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
56 cliflag: '-a',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
57 clivalue: (params.filtlong_a ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
58 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
59 'filtlong_1': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
60 clihelp: 'External reference Illumina reads in FASTQ format (R1). ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
61 "Default: ${params.filtlong_1}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
62 cliflag: '-1',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
63 clivalue: (params.filtlong_1 ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
64 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
65 'filtlong_2': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
66 clihelp: 'External reference Illumina reads in FASTQ format (R2). ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
67 "Default: ${params.filtlong_2}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
68 cliflag: '--2',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
69 clivalue: (params.filtlong_2 ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
70 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
71 'filtlong_len_weight': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
72 clihelp: 'Weight given to the length score. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
73 "Default: ${params.filtlong_len_weight}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
74 cliflag: '--length_weight',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
75 clivalue: (params.filtlong_len_weight ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
76 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
77 'filtlong_mean_q_weight': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
78 clihelp: 'Weight given to the mean quality score. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
79 "Default: ${params.filtlong_mean_q_weight}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
80 cliflag: '--mean_q_weight',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
81 clivalue: (params.filtlong_mean_q_weight ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
82 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
83 'filtlong_window_q_weight': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
84 clihelp: 'Weight given to the window quality score. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
85 "Default: ${params.filtlong_window_q_weight}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
86 cliflag: '--window_q_weight',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
87 clivalue: (params.filtlong_window_q_weight ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
88 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
89 'filtlong_trim': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
90 clihelp: 'Trim non k-mer matching bases from start/end of the reads. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
91 "Default: ${params.filtlong_trim}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
92 cliflag: '--trim',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
93 clivalue: (params.filtlong_trim ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
94 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
95 'filtlong_split': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
96 clihelp: 'Split reads at this many (or more) consecutive non k-mer matching bases. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
97 "Default: ${params.filtlong_split}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
98 cliflag: '--split',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
99 clivalue: (params.filtlong_split ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
100 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
101 'filtlong_window_size': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
102 clihelp: 'Size of sliding window used when measuring window quality. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
103 "Default: ${params.filtlong_window_size}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
104 cliflag: '--window_size',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
105 clivalue: (params.filtlong_window_size ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
106 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
107 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
108
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
109 toolspecs.each {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
110 k, v -> tool.text['--' + k] = "${v.clihelp}"
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
111 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
112 }
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
113
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
114 return tool
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
115 }