kkonganti@1: // Help text for kma align within CPIPES.
kkonganti@1: 
kkonganti@1: def kmaalignHelp(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:         'kmaalign_run': [
kkonganti@1:             clihelp: 'Run kma tool. Default: ' +
kkonganti@1:                 (params.kmaalign_run ?: false),
kkonganti@1:             cliflag: null,
kkonganti@1:             clivalue: null
kkonganti@1:         ],
kkonganti@1:         'kmaalign_int': [
kkonganti@1:             clihelp: 'Input file has interleaved reads. ' +
kkonganti@1:                 " Default: ${params.kmaalign_int}",
kkonganti@1:             cliflag: '-int',
kkonganti@1:             clivalue: (params.kmaalign_int ? ' ' : '')
kkonganti@1:         ], 
kkonganti@1:         'kmaalign_ef': [
kkonganti@1:             clihelp: 'Output additional features. ' +
kkonganti@1:                 "Default: ${params.kmaalign_ef}",
kkonganti@1:             cliflag: '-ef',
kkonganti@1:             clivalue: (params.kmaalign_ef ? ' ' : '')
kkonganti@1:         ], 
kkonganti@1:         'kmaalign_vcf': [
kkonganti@1:             clihelp: 'Output vcf file. 2 to apply FT. ' +
kkonganti@1:                 "Default: ${params.kmaalign_vcf}",
kkonganti@1:             cliflag: '-vcf',
kkonganti@1:             clivalue: (params.kmaalign_vcf ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_sam': [
kkonganti@1:             clihelp: 'Output SAM, 4/2096 for mapped/aligned. ' +
kkonganti@1:                 "Default: ${params.kmaalign_sam}",
kkonganti@1:             cliflag: '-sam',
kkonganti@1:             clivalue: (params.kmaalign_sam ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_nc': [
kkonganti@1:             clihelp: 'No consensus file. ' +
kkonganti@1:                 "Default: ${params.kmaalign_nc}",
kkonganti@1:             cliflag: '-nc',
kkonganti@1:             clivalue: (params.kmaalign_nc ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_na': [
kkonganti@1:             clihelp: 'No aln file. ' +
kkonganti@1:                 "Default: ${params.kmaalign_na}",
kkonganti@1:             cliflag: '-na',
kkonganti@1:             clivalue: (params.kmaalign_na ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_nf': [
kkonganti@1:             clihelp: 'No frag file. ' +
kkonganti@1:                 "Default: ${params.kmaalign_nf}",
kkonganti@1:             cliflag: '-nf',
kkonganti@1:             clivalue: (params.kmaalign_nf ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_a': [
kkonganti@1:             clihelp: 'Output all template mappings. ' +
kkonganti@1:                 "Default: ${params.kmaalign_a}",
kkonganti@1:             cliflag: '-a',
kkonganti@1:             clivalue: (params.kmaalign_a ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_and': [
kkonganti@1:             clihelp: 'Use both -mrs and p-value on consensus. ' +
kkonganti@1:                 "Default: ${params.kmaalign_and}",
kkonganti@1:             cliflag: '-and',
kkonganti@1:             clivalue: (params.kmaalign_and ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_oa': [
kkonganti@1:             clihelp: 'Use neither -mrs or p-value on consensus. ' +
kkonganti@1:                 "Default: ${params.kmaalign_oa}",
kkonganti@1:             cliflag: '-oa',
kkonganti@1:             clivalue: (params.kmaalign_oa ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_bc': [
kkonganti@1:             clihelp: 'Minimum support to call bases. ' +
kkonganti@1:                 "Default: ${params.kmaalign_bc}",
kkonganti@1:             cliflag: '-bc',
kkonganti@1:             clivalue: (params.kmaalign_bc ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_bcNano': [
kkonganti@1:             clihelp: 'Altered indel calling for ONT data. ' +
kkonganti@1:                 "Default: ${params.kmaalign_bcNano}",
kkonganti@1:             cliflag: '-bcNano',
kkonganti@1:             clivalue: (params.kmaalign_bcNano ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_bcd': [
kkonganti@1:             clihelp: 'Minimum depth to call bases. ' +
kkonganti@1:                 "Default: ${params.kmaalign_bcd}",
kkonganti@1:             cliflag: '-bcd',
kkonganti@1:             clivalue: (params.kmaalign_bcd ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_bcg': [
kkonganti@1:             clihelp: 'Maintain insignificant gaps. ' +
kkonganti@1:                 "Default: ${params.kmaalign_bcg}",
kkonganti@1:             cliflag: '-bcg',
kkonganti@1:             clivalue: (params.kmaalign_bcg ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_ID': [
kkonganti@1:             clihelp: 'Minimum consensus ID. ' +
kkonganti@1:                 "Default: ${params.kmaalign_ID}",
kkonganti@1:             cliflag: '-ID',
kkonganti@1:             clivalue: (params.kmaalign_ID ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_md': [
kkonganti@1:             clihelp: 'Minimum depth. ' +
kkonganti@1:                 "Default: ${params.kmaalign_md}",
kkonganti@1:             cliflag: '-md',
kkonganti@1:             clivalue: (params.kmaalign_md ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_dense': [
kkonganti@1:             clihelp: 'Skip insertion in consensus. ' +
kkonganti@1:                 "Default: ${params.kmaalign_dense}",
kkonganti@1:             cliflag: '-dense',
kkonganti@1:             clivalue: (params.kmaalign_dense ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_ref_fsa': [
kkonganti@1:             clihelp: 'Use Ns on indels. ' +
kkonganti@1:                 "Default: ${params.kmaalign_ref_fsa}",
kkonganti@1:             cliflag: '-ref_fsa',
kkonganti@1:             clivalue: (params.kmaalign_ref_fsa ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_Mt1': [
kkonganti@1:             clihelp: 'Map everything to one template. ' +
kkonganti@1:                 "Default: ${params.kmaalign_Mt1}",
kkonganti@1:             cliflag: '-Mt1',
kkonganti@1:             clivalue: (params.kmaalign_Mt1 ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_1t1': [
kkonganti@1:             clihelp: 'Map one query to one template. ' +
kkonganti@1:                 "Default: ${params.kmaalign_1t1}",
kkonganti@1:             cliflag: '-1t1',
kkonganti@1:             clivalue: (params.kmaalign_1t1 ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_mrs': [
kkonganti@1:             clihelp: 'Minimum relative alignment score. ' +
kkonganti@1:                 "Default: ${params.kmaalign_mrs}",
kkonganti@1:             cliflag: '-mrs',
kkonganti@1:             clivalue: (params.kmaalign_mrs ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_mrc': [
kkonganti@1:             clihelp: 'Minimum query coverage. ' +
kkonganti@1:                 "Default: ${params.kmaalign_mrc}",
kkonganti@1:             cliflag: '-mrc',
kkonganti@1:             clivalue: (params.kmaalign_mrc ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_mp': [
kkonganti@1:             clihelp: 'Minimum phred score of trailing and leading bases. ' +
kkonganti@1:                 "Default: ${params.kmaalign_mp}",
kkonganti@1:             cliflag: '-mp',
kkonganti@1:             clivalue: (params.kmaalign_mp ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_mq': [
kkonganti@1:             clihelp: 'Set the minimum mapping quality. ' +
kkonganti@1:                 "Default: ${params.kmaalign_mq}",
kkonganti@1:             cliflag: '-mq',
kkonganti@1:             clivalue: (params.kmaalign_mq ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_eq': [
kkonganti@1:             clihelp: 'Minimum average quality score. ' +
kkonganti@1:                 "Default: ${params.kmaalign_eq}",
kkonganti@1:             cliflag: '-eq',
kkonganti@1:             clivalue: (params.kmaalign_eq ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_5p': [
kkonganti@1:             clihelp: 'Trim 5 prime by this many bases. ' +
kkonganti@1:                 "Default: ${params.kmaalign_5p}",
kkonganti@1:             cliflag: '-5p',
kkonganti@1:             clivalue: (params.kmaalign_5p ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_3p': [
kkonganti@1:             clihelp: 'Trim 3 prime by this many bases ' +
kkonganti@1:                 "Default: ${params.kmaalign_3p}",
kkonganti@1:             cliflag: '-3p',
kkonganti@1:             clivalue: (params.kmaalign_3p ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_apm': [
kkonganti@1:             clihelp: 'Sets both -pm and -fpm ' +
kkonganti@1:                 "Default: ${params.kmaalign_apm}",
kkonganti@1:             cliflag: '-apm',
kkonganti@1:             clivalue: (params.kmaalign_apm ?: '')
kkonganti@1:         ],
kkonganti@1:         'kmaalign_cge': [
kkonganti@1:             clihelp: 'Set CGE penalties and rewards ' +
kkonganti@1:                 "Default: ${params.kmaalign_cge}",
kkonganti@1:             cliflag: '-cge',
kkonganti@1:             clivalue: (params.kmaalign_cge ? ' ' : '')
kkonganti@1:         ],
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: }