kkonganti@11: // Help text for sourmash_filter_hits.py (sfhpy) within CPIPES.
kkonganti@11: def sfhpyHelp(params) {
kkonganti@11: 
kkonganti@11:     Map tool = [:]
kkonganti@11:     Map toolspecs = [:]
kkonganti@11:     tool.text = [:]
kkonganti@11:     tool.helpparams = [:]
kkonganti@11: 
kkonganti@11:     toolspecs = [
kkonganti@11:         'sfhpy_run': [
kkonganti@11:             clihelp: 'Run the sourmash_filter_hits.py ' +
kkonganti@11:                 'script. Default: ' +
kkonganti@11:                 (params.sfhpy_run ?: false),
kkonganti@11:             cliflag: null,
kkonganti@11:             clivalue: null
kkonganti@11:         ],
kkonganti@11:         'sfhpy_fcn': [
kkonganti@11:             clihelp: 'Column name by which filtering of rows should be applied. ' +
kkonganti@11:                 "Default: ${params.sfhpy_fcn}",
kkonganti@11:             cliflag: '-fcn',
kkonganti@11:             clivalue: (params.sfhpy_fcn ?: '')
kkonganti@11:         ],
kkonganti@11:         'sfhpy_fcv': [
kkonganti@11:             clihelp: 'Remove genomes whose match with the query FASTQ is less than ' +
kkonganti@11:                 'this much. ' +
kkonganti@11:                 "Default: ${params.sfhpy_fcv}",
kkonganti@11:             cliflag: '-fcv',
kkonganti@11:             clivalue: (params.sfhpy_fcv ?: '')
kkonganti@11:         ],
kkonganti@11:         'sfhpy_gt': [
kkonganti@11:             clihelp: 'Apply greather than or equal to condition on numeric values of ' +
kkonganti@11:                 '--sfhpy_fcn column. ' +
kkonganti@11:                 "Default: ${params.sfhpy_gt}",
kkonganti@11:             cliflag: '-gt',
kkonganti@11:             clivalue: (params.sfhpy_gt ? ' ' : '')
kkonganti@11:         ],
kkonganti@11:         'sfhpy_lt': [
kkonganti@11:             clihelp: 'Apply less than or equal to condition on numeric values of ' +
kkonganti@11:                 '--sfhpy_fcn column. ' +
kkonganti@11:                 "Default: ${params.sfhpy_lt}",
kkonganti@11:             cliflag: '-gt',
kkonganti@11:             clivalue: (params.sfhpy_lt ? ' ' : '')
kkonganti@11:         ],
kkonganti@11:     ]
kkonganti@11: 
kkonganti@11:     toolspecs.each {
kkonganti@11:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@11:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@11:     }
kkonganti@11: 
kkonganti@11:     return tool
kkonganti@11: }