annotate 0.3.0/lib/help/seqkitgrep.nf @ 92:295c2597a475

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