annotate 0.2.0/lib/help/seqkitgrep.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 seqkit grep within CPIPES.
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
2
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
3 def seqkitgrepHelp(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 'seqkit_grep_n': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Match by full name instead of just ID. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
13 "Default: " + (params.seqkit_grep_n ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: '--seqkit_grep_n',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: (params.seqkit_grep_n ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
16 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
17 'seqkit_grep_s': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'Search subseq on seq, both positive and negative ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
19 'strand are searched, and mismatch allowed using flag --seqkit_grep_m. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
20 "Default: " + (params.seqkit_grep_s ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
21 cliflag: '--seqkit_grep_s',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
22 clivalue: (params.seqkit_grep_s ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
23 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
24 'seqkit_grep_c': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
25 clihelp: 'Input is circular genome ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
26 "Default: " + (params.seqkit_grep_c ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
27 cliflag: '--seqkit_grep_c',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
28 clivalue: (params.seqkit_grep_c ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
29 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
30 'seqkit_grep_C': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
31 clihelp: 'Just print a count of matching records. With the ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
32 '--seqkit_grep_v flag, count non-matching records. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
33 "Default: " + (params.seqkit_grep_v ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
34 cliflag: '--seqkit_grep_v',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
35 clivalue: (params.seqkit_grep_v ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
36 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
37 'seqkit_grep_i': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
38 clihelp: 'Ignore case while using seqkit grep. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
39 "Default: " + (params.seqkit_grep_i ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
40 cliflag: '--seqkit_grep_i',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
41 clivalue: (params.seqkit_grep_i ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
42 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
43 'seqkit_grep_v': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
44 clihelp: 'Invert the match i.e. select non-matching records. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
45 "Default: " + (params.seqkit_grep_v ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
46 cliflag: '--seqkit_grep_v',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
47 clivalue: (params.seqkit_grep_v ? ' ' : '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
48 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
49 'seqkit_grep_m': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
50 clihelp: 'Maximum mismatches when matching by sequence. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
51 "Default: " + (params.seqkit_grep_m ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
52 cliflag: '--seqkit_grep_m',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
53 clivalue: (params.seqkit_grep_v ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
54 ],
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
55 'seqkit_grep_r': [
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
56 clihelp: 'Input patters are regular expressions. ' +
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
57 "Default: " + (params.seqkit_grep_m ?: 'undefined'),
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
58 cliflag: '--seqkit_grep_m',
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
59 clivalue: (params.seqkit_grep_v ?: '')
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
60 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
61 ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
62
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
63 toolspecs.each {
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
64 k, v -> tool.text['--' + k] = "${v.clihelp}"
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
65 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
66 }
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
67
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
68 return tool
9e8b1c747a6a planemo upload
galaxytrakr
parents:
diff changeset
69 }