annotate 0.5.0/lib/help/seqkitgrep.nf @ 1:365849f031fd

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