annotate 0.6.1/lib/help/seqkitgrep.nf @ 15:1972677994a6

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