kkonganti@1: // Help text for sourmash gather within CPIPES.
kkonganti@1: 
kkonganti@1: def sourmashgatherHelp(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:         'sourmashgather_run': [
kkonganti@1:             clihelp: 'Run `sourmash gather` tool. Default: ' +
kkonganti@1:                 (params.sourmashgather_run ?: false),
kkonganti@1:             cliflag: null,
kkonganti@1:             clivalue: null
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_n': [
kkonganti@1:             clihelp: 'Number of results to report. ' +
kkonganti@1:                 'By default, will terminate at --sourmashgather_thr_bp value. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_n}",
kkonganti@1:             cliflag: '-n',
kkonganti@1:             clivalue: (params.sourmashgather_n ?: '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_thr_bp': [
kkonganti@1:             clihelp: 'Reporting threshold (in bp) for estimated overlap with remaining query. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_thr_bp}",
kkonganti@1:             cliflag: '--threshold-bp',
kkonganti@1:             clivalue: (params.sourmashgather_thr_bp ?: '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_ignoreabn': [
kkonganti@1:             clihelp: 'Do NOT use k-mer abundances if present. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_ignoreabn}",
kkonganti@1:             cliflag: '--ignore-abundance',
kkonganti@1:             clivalue: (params.sourmashgather_ignoreabn ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_prefetch': [
kkonganti@1:             clihelp: 'Use prefetch before gather. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_prefetch}",
kkonganti@1:             cliflag: '--prefetch',
kkonganti@1:             clivalue: (params.sourmashgather_prefetch ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_noprefetch': [
kkonganti@1:             clihelp: 'Do not use prefetch before gather. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_noprefetch}",
kkonganti@1:             cliflag: '--no-prefetch',
kkonganti@1:             clivalue: (params.sourmashgather_noprefetch ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_ani_ci': [
kkonganti@1:             clihelp: 'Output confidence intervals for ANI estimates. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_ani_ci}",
kkonganti@1:             cliflag: '--estimate-ani-ci',
kkonganti@1:             clivalue: (params.sourmashgather_ani_ci ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_k': [
kkonganti@1:             clihelp: 'The k-mer size to select. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_k}",
kkonganti@1:             cliflag: '-k',
kkonganti@1:             clivalue: (params.sourmashgather_k ?: '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_protein': [
kkonganti@1:             clihelp: 'Choose a protein signature. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_protein}",
kkonganti@1:             cliflag: '--protein',
kkonganti@1:             clivalue: (params.sourmashgather_protein ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_noprotein': [
kkonganti@1:             clihelp: 'Do not choose a protein signature. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_noprotein}",
kkonganti@1:             cliflag: '--no-protein',
kkonganti@1:             clivalue: (params.sourmashgather_noprotein ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_dayhoff': [
kkonganti@1:             clihelp: 'Choose Dayhoff-encoded amino acid signatures. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_dayhoff}",
kkonganti@1:             cliflag: '--dayhoff',
kkonganti@1:             clivalue: (params.sourmashgather_dayhoff ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_nodayhoff': [
kkonganti@1:             clihelp: 'Do not choose Dayhoff-encoded amino acid signatures. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_nodayhoff}",
kkonganti@1:             cliflag: '--no-dayhoff',
kkonganti@1:             clivalue: (params.sourmashgather_nodayhoff ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_hp': [
kkonganti@1:             clihelp: 'Choose hydrophobic-polar-encoded amino acid signatures. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_hp}",
kkonganti@1:             cliflag: '--hp',
kkonganti@1:             clivalue: (params.sourmashgather_hp ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_nohp': [
kkonganti@1:             clihelp: 'Do not choose hydrophobic-polar-encoded amino acid signatures. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_nohp}",
kkonganti@1:             cliflag: '--no-hp',
kkonganti@1:             clivalue: (params.sourmashgather_nohp ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_dna': [
kkonganti@1:             clihelp: 'Choose DNA signature. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_dna}",
kkonganti@1:             cliflag: '--dna',
kkonganti@1:             clivalue: (params.sourmashgather_dna ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_nodna': [
kkonganti@1:             clihelp: 'Do not choose DNA signature. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_nodna}",
kkonganti@1:             cliflag: '--no-dna',
kkonganti@1:             clivalue: (params.sourmashgather_nodna ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_scaled': [
kkonganti@1:             clihelp: 'Scaled value should be between 100 and 1e6. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_scaled}",
kkonganti@1:             cliflag: '--scaled',
kkonganti@1:             clivalue: (params.sourmashgather_scaled ?: '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_inc_pat': [
kkonganti@1:             clihelp: 'Search only signatures that match this pattern in name, filename, or md5. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_inc_pat}",
kkonganti@1:             cliflag: '--include-db-pattern',
kkonganti@1:             clivalue: (params.sourmashgather_inc_pat ?: '')
kkonganti@1:         ],
kkonganti@1:         'sourmashgather_exc_pat': [
kkonganti@1:             clihelp: 'Search only signatures that do not match this pattern in name, filename, or md5. ' +
kkonganti@1:                 "Default: ${params.sourmashgather_exc_pat}",
kkonganti@1:             cliflag: '--exclude-db-pattern',
kkonganti@1:             clivalue: (params.sourmashgather_exc_pat ?: '')
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: }