annotate 0.4.0/lib/help/seqkitgrep.nf @ 101:ce6d9548fe89

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