kkonganti@101: // Help text for centrifuge within CPIPES.
kkonganti@101: 
kkonganti@101: def centrifugeHelp(params) {
kkonganti@101: 
kkonganti@101:     Map tool = [:]
kkonganti@101:     Map toolspecs = [:]
kkonganti@101:     tool.text = [:]
kkonganti@101:     tool.helpparams = [:]
kkonganti@101: 
kkonganti@101:     toolspecs = [
kkonganti@101:         'centrifuge_x': [
kkonganti@101:             clihelp: "Absolute path to centrifuge database. Default: ${params.centrifuge_x}",
kkonganti@101:             cliflag: '-x',
kkonganti@101:             clivalue: null
kkonganti@101:         ],
kkonganti@101:         'centrifuge_save_unaligned': [
kkonganti@101:             clihelp: 'Save SINGLE-END reads that did not align. For PAIRED-END' +
kkonganti@101:                 " reads, save read pairs that did not align concordantly. Default: ${params.centrifuge_save_unaligned}",
kkonganti@101:             cliflag: null, // Handled in modules logic.
kkonganti@101:             clivalue: null
kkonganti@101:         ],
kkonganti@101:         'centrifuge_save_aligned': [
kkonganti@101:             clihelp: 'Save SINGLE-END reads that aligned. For PAIRED-END' +
kkonganti@101:                 " reads, save read pairs that aligned concordantly. Default: ${params.centrifuge_save_aligned}",
kkonganti@101:             cliflag: null, // Handled in modules logic.
kkonganti@101:             clivalue: null
kkonganti@101:         ],
kkonganti@101:         'centrifuge_out_fmt_sam': [
kkonganti@101:             clihelp: "Centrifuge output should be in SAM. Default: ${params.centrifuge_save_aligned}",
kkonganti@101:             cliflag: null, // Handled in modules logic.
kkonganti@101:             clivalue: null
kkonganti@101:         ],
kkonganti@101:         'centrifuge_extract_bug': [
kkonganti@101:             clihelp: "Extract this bug from centrifuge results." +
kkonganti@101:                 " Default: ${params.centrifuge_extract_bug}",
kkonganti@101:             cliflag: null, // Handled in modules logic.
kkonganti@101:             clivalue: null,
kkonganti@101:         ],
kkonganti@101:         'centrifuge_ignore_quals': [
kkonganti@101:             clihelp: 'Treat all quality values as 30 on Phred scale. ' +
kkonganti@101:                 "Default: ${params.centrifuge_ignore_quals}",
kkonganti@101:             cliflag: '--ignore-quals',
kkonganti@101:             clivalue: (params.centrifuge_ignore_quals ? ' ' : '')
kkonganti@101:         ]
kkonganti@101:     ]
kkonganti@101: 
kkonganti@101:     toolspecs.each {
kkonganti@101:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@101:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@101:     }
kkonganti@101: 
kkonganti@101:     return tool
kkonganti@101: }
kkonganti@101: