kkonganti@1: // Help text for sourmash sketch dna within CPIPES.
kkonganti@1: 
kkonganti@1: def sourmashsketchHelp(params) {
kkonganti@1: 
kkonganti@1:     Map tool = [:]
kkonganti@1:     Map toolspecs = [:]
kkonganti@1:     tool.text = [:]
kkonganti@1:     tool.helpparams = [:]
kkonganti@1: 
kkonganti@1:     toolspecs = [
kkonganti@1:         'sourmashsketch_run': [
kkonganti@1:             clihelp: 'Run `sourmash sketch dna` tool. Default: ' +
kkonganti@1:                 (params.sourmashsketch_run ?: false),
kkonganti@1:             cliflag: null,
kkonganti@1:             clivalue: null
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_mode': [
kkonganti@1:             clihelp: "Select which type of signatures to be created: dna, protein, fromfile or translate. "
kkonganti@1:                 + "Default: ${params.sourmashsketch_mode}",
kkonganti@1:             cliflag: "${params.sourmashsketch_mode}",
kkonganti@1:             clivalue: ' '
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_p': [
kkonganti@1:             clihelp: 'Signature parameters to use. ' +
kkonganti@1:                 "Default: ${params.sourmashsketch_p}",
kkonganti@1:             cliflag: '-p',
kkonganti@1:             clivalue: (params.sourmashsketch_p ?: '')
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_file': [
kkonganti@1:             clihelp: '<path>  A text file containing a list of sequence files to load. ' +
kkonganti@1:                 "Default: ${params.sourmashsketch_file}",
kkonganti@1:             cliflag: '--from-file',
kkonganti@1:             clivalue: (params.sourmashsketch_file ?: '')
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_f': [
kkonganti@1:             clihelp: 'Recompute signatures even if the file exists. ' +
kkonganti@1:                 "Default: ${params.sourmashsketch_f}",
kkonganti@1:             cliflag: '-f',
kkonganti@1:             clivalue: (params.sourmashsketch_f ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_merge': [
kkonganti@1:             clihelp: 'Merge all input files into one signature file with the specified name. ' +
kkonganti@1:                 "Default: ${params.sourmashsketch_merge}",
kkonganti@1:             cliflag: '--merge',
kkonganti@1:             clivalue: (params.sourmashsketch_merge ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_singleton': [
kkonganti@1:             clihelp: 'Compute a signature for each sequence record individually. ' +
kkonganti@1:                 "Default: ${params.sourmashsketch_singleton}",
kkonganti@1:             cliflag: '--singleton',
kkonganti@1:             clivalue: (params.sourmashsketch_singleton ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_name': [
kkonganti@1:             clihelp: 'Name the signature generated from each file after the first record in the file. ' +
kkonganti@1:                 "Default: ${params.sourmashsketch_name}",
kkonganti@1:             cliflag: '--name-from-first',
kkonganti@1:             clivalue: (params.sourmashsketch_name ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashsketch_randomize': [
kkonganti@1:             clihelp: 'Shuffle the list of input files randomly. ' +
kkonganti@1:                 "Default: ${params.sourmashsketch_randomize}",
kkonganti@1:             cliflag: '--randomize',
kkonganti@1:             clivalue: (params.sourmashsketch_randomize ? ' ' : '')
kkonganti@1:         ]
kkonganti@1:     ]
kkonganti@1: 
kkonganti@1:     toolspecs.each {
kkonganti@1:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1:     }
kkonganti@1: 
kkonganti@1:     return tool
kkonganti@1: }