kkonganti@1: // Help text for kraken2 within CPIPES.
kkonganti@1: 
kkonganti@1: def kraken2Help(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:         'kraken2_db': [
kkonganti@1:             clihelp: "Absolute path to kraken database. Default: ${params.kraken2_db}",
kkonganti@1:             cliflag: '--db',
kkonganti@1:             clivalue: null
kkonganti@1:         ],
kkonganti@1:         'kraken2_confidence': [
kkonganti@1:             clihelp: 'Confidence score threshold which must be ' +
kkonganti@1:                 "between 0 and 1. Default: ${params.kraken2_confidence}",
kkonganti@1:             cliflag: '--confidence',
kkonganti@1:             clivalue: (params.kraken2_confidence ?: '')
kkonganti@1:         ],
kkonganti@1:         'kraken2_quick': [
kkonganti@1:             clihelp: "Quick operation (use first hit or hits). Default: ${params.kraken2_quick}",
kkonganti@1:             cliflag: '--quick',
kkonganti@1:             clivalue: (params.kraken2_quick ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kraken2_use_mpa_style': [
kkonganti@1:             clihelp: "Report output like Kraken 1's " +
kkonganti@1:                 "kraken-mpa-report. Default: ${params.kraken2_use_mpa_style}",
kkonganti@1:             cliflag: '--use-mpa-style',
kkonganti@1:             clivalue: (params.kraken2_use_mpa_style ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kraken2_minimum_base_quality': [
kkonganti@1:             clihelp: 'Minimum base quality used in classification ' +
kkonganti@1:                 " which is only effective with FASTQ input. Default: ${params.kraken2_minimum_base_quality}",
kkonganti@1:             cliflag: '--minimum-base-quality',
kkonganti@1:             clivalue: (params.kraken2_minimum_base_quality ?: '')
kkonganti@1:         ],
kkonganti@1:         'kraken2_report_zero_counts': [
kkonganti@1:             clihelp: 'Report counts for ALL taxa, even if counts are zero. ' +
kkonganti@1:                 "Default: ${params.kraken2_report_zero_counts}",
kkonganti@1:             cliflag: '--report-zero-counts',
kkonganti@1:             clivalue: (params.kraken2_report_zero_counts ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kraken2_report_minmizer_data': [
kkonganti@1:             clihelp: 'Report minimizer and distinct minimizer count' +
kkonganti@1:                 ' information in addition to normal Kraken report. ' +
kkonganti@1:                 "Default: ${params.kraken2_report_minimizer_data}",
kkonganti@1:             cliflag: '--report-minimizer-data',
kkonganti@1:             clivalue: (params.kraken2_report_minimizer_data ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kraken2_use_names': [
kkonganti@1:             clihelp: 'Print scientific names instead of just taxids. ' +
kkonganti@1:                 "Default: ${params.kraken2_use_names}",
kkonganti@1:             cliflag: '--use-names',
kkonganti@1:             clivalue: (params.kraken2_use_names ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kraken2_extract_bug': [
kkonganti@1:             clihelp: 'Extract the reads or contigs beloging to this bug. ' +
kkonganti@1:                 "Default: ${params.kraken2_extract_bug}",
kkonganti@1:             cliflag: null,
kkonganti@1:             clivalue: null
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: }