kkonganti@0: // Help text for sourmash sigkmers within CPIPES.
kkonganti@0: 
kkonganti@0: def sourmashsigkmersHelp(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:         'sourmashsigkmers_run': [
kkonganti@0:             clihelp: 'Run `sourmash sigkmers` tool. Default: ' +
kkonganti@0:                 (params.sourmashsigkmers_run ?: false),
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_k': [
kkonganti@0:             clihelp: 'The k-mer size to select. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_k}",
kkonganti@0:             cliflag: '-k',
kkonganti@0:             clivalue: (params.sourmashsigkmers_k ?: '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_protein': [
kkonganti@0:             clihelp: 'Choose a protein signature. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_protein}",
kkonganti@0:             cliflag: '--protein',
kkonganti@0:             clivalue: (params.sourmashsigkmers_protein ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_noprotein': [
kkonganti@0:             clihelp: 'Do not choose a protein signature. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_noprotein}",
kkonganti@0:             cliflag: '--no-protein',
kkonganti@0:             clivalue: (params.sourmashsigkmers_noprotein ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_dayhoff': [
kkonganti@0:             clihelp: 'Choose Dayhoff-encoded amino acid signatures. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_dayhoff}",
kkonganti@0:             cliflag: '--dayhoff',
kkonganti@0:             clivalue: (params.sourmashsigkmers_dayhoff ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_nodayhoff': [
kkonganti@0:             clihelp: 'Do not choose Dayhoff-encoded amino acid signatures. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_nodayhoff}",
kkonganti@0:             cliflag: '--no-dayhoff',
kkonganti@0:             clivalue: (params.sourmashsigkmers_nodayhoff ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_hp': [
kkonganti@0:             clihelp: 'Choose hydrophobic-polar-encoded amino acid signatures. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_hp}",
kkonganti@0:             cliflag: '--hp',
kkonganti@0:             clivalue: (params.sourmashsigkmers_hp ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_nohp': [
kkonganti@0:             clihelp: 'Do not choose hydrophobic-polar-encoded amino acid signatures. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_nohp}",
kkonganti@0:             cliflag: '--no-hp',
kkonganti@0:             clivalue: (params.sourmashsigkmers_nohp ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_dna': [
kkonganti@0:             clihelp: 'Choose DNA signature. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_dna}",
kkonganti@0:             cliflag: '--dna',
kkonganti@0:             clivalue: (params.sourmashsigkmers_dna ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_nodna': [
kkonganti@0:             clihelp: 'Do not choose DNA signature. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_nodna}",
kkonganti@0:             cliflag: '--no-dna',
kkonganti@0:             clivalue: (params.sourmashsigkmers_nodna ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_save_kmers': [
kkonganti@0:             clihelp: 'Save k-mers and hash values to a CSV file. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_save_kmers}",
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_save_seqs': [
kkonganti@0:             clihelp: 'Save sequences with matching hash values to a FASTA file. ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_save_seqs}",
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'sourmashsigkmers_translate': [
kkonganti@0:             clihelp: 'Translate DNA k-mers into amino acids (for protein, dayhoff, and hp sketches). ' +
kkonganti@0:                 "Default: ${params.sourmashsigkmers_translate}",
kkonganti@0:             cliflag: '--translate',
kkonganti@0:             clivalue: (params.sourmashsigkmers_translate ? ' ' : '')
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: }