kkonganti@0: // Help text for seqkit grep within CPIPES.
kkonganti@0: 
kkonganti@0: def seqkitgrepHelp(params) {
kkonganti@0: 
kkonganti@0:     Map tool = [:]
kkonganti@0:     Map toolspecs = [:]
kkonganti@0:     tool.text = [:]
kkonganti@0:     tool.helpparams = [:]
kkonganti@0: 
kkonganti@0:     toolspecs = [
kkonganti@0:         'seqkit_grep_n': [
kkonganti@0:             clihelp: 'Match by full name instead of just ID. ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_n ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_n',
kkonganti@0:             clivalue: (params.seqkit_grep_n ? ' ' : '')
kkonganti@0:         ], 
kkonganti@0:         'seqkit_grep_s': [
kkonganti@0:             clihelp: 'Search subseq on seq, both positive and negative ' +
kkonganti@0:                 'strand are searched, and mismatch allowed using flag --seqkit_grep_m. ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_s ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_s',
kkonganti@0:             clivalue: (params.seqkit_grep_s ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'seqkit_grep_c': [
kkonganti@0:             clihelp: 'Input is circular genome ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_c ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_c',
kkonganti@0:             clivalue: (params.seqkit_grep_c ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'seqkit_grep_C': [
kkonganti@0:             clihelp: 'Just print a count of matching records. With the ' +
kkonganti@0:                 '--seqkit_grep_v flag, count non-matching records. ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_v ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_v',
kkonganti@0:             clivalue: (params.seqkit_grep_v ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'seqkit_grep_i': [
kkonganti@0:             clihelp: 'Ignore case while using seqkit grep. ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_i ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_i',
kkonganti@0:             clivalue: (params.seqkit_grep_i ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'seqkit_grep_v': [
kkonganti@0:             clihelp: 'Invert the match i.e. select non-matching records. ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_v ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_v',
kkonganti@0:             clivalue: (params.seqkit_grep_v ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'seqkit_grep_m': [
kkonganti@0:             clihelp: 'Maximum mismatches when matching by sequence. ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_m ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_m',
kkonganti@0:             clivalue: (params.seqkit_grep_v ?: '')
kkonganti@0:         ],
kkonganti@0:         'seqkit_grep_r': [
kkonganti@0:             clihelp: 'Input patters are regular expressions. ' +
kkonganti@0:                 "Default: " + (params.seqkit_grep_m ?: 'undefined'),
kkonganti@0:             cliflag: '--seqkit_grep_m',
kkonganti@0:             clivalue: (params.seqkit_grep_v ?: '')
kkonganti@0:         ]
kkonganti@0:     ]
kkonganti@0: 
kkonganti@0:     toolspecs.each {
kkonganti@0:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0:     }
kkonganti@0: 
kkonganti@0:     return tool
kkonganti@0: }