annotate 0.4.2/lib/help/seqkitgrep.nf @ 143:620bffa66bbb tip

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