kkonganti@17: // Help text for mash screen within CPIPES.
kkonganti@17: 
kkonganti@17: def mashscreenHelp(params) {
kkonganti@17: 
kkonganti@17:     Map tool = [:]
kkonganti@17:     Map toolspecs = [:]
kkonganti@17:     tool.text = [:]
kkonganti@17:     tool.helpparams = [:]
kkonganti@17: 
kkonganti@17:     toolspecs = [
kkonganti@17:         'mashscreen_run': [
kkonganti@17:             clihelp: 'Run `mash screen` tool. Default: ' +
kkonganti@17:                 (params.mashscreen_run ?: false),
kkonganti@17:             cliflag: null,
kkonganti@17:             clivalue: null
kkonganti@17:         ],
kkonganti@17:         'mashscreen_w': [
kkonganti@17:             clihelp: 'Winner-takes-all strategy for identity estimates. After counting ' +
kkonganti@17:                 'hashes for each query, hashes that appear in multiple queries will ' +
kkonganti@17:                 'be removed from all except the one with the best identity (ties ' +
kkonganti@17:                 'broken by larger query), and other identities will be reduced. This ' +
kkonganti@17:                 'removes output redundancy, providing a rough compositional outline. ' +
kkonganti@17:                 " Default: ${params.mashscreen_w}",
kkonganti@17:             cliflag: '-w',
kkonganti@17:             clivalue: (params.mashscreen_w ? ' ' : '')
kkonganti@17:         ], 
kkonganti@17:         'mashscreen_i': [
kkonganti@17:             clihelp: 'Minimum identity to report. Inclusive unless set to zero, in which ' +
kkonganti@17:                 'case only identities greater than zero (i.e. with at least one ' +
kkonganti@17:                 'shared hash) will be reported. Set to -1 to output everything. ' +
kkonganti@17:                 "(-1-1). Default: ${params.mashscreen_i}",
kkonganti@17:             cliflag: '-i',
kkonganti@17:             clivalue: (params.mashscreen_i ?: '')
kkonganti@17:         ],
kkonganti@17:         'mashscreen_v': [
kkonganti@17:             clihelp: 'Maximum p-value to report (0-1). ' +
kkonganti@17:                 "Default: ${params.mashscreen_v}",
kkonganti@17:             cliflag: '-v',
kkonganti@17:             clivalue: (params.mashscreen_v ?: '')
kkonganti@17:         ]
kkonganti@17:     ]
kkonganti@17: 
kkonganti@17:     toolspecs.each {
kkonganti@17:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@17:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@17:     }
kkonganti@17: 
kkonganti@17:     return tool
kkonganti@17: }