annotate 0.2.1/lib/help/seqkitgrep.nf @ 0:77494b0fa3c7

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