annotate 0.5.0/lib/help/centrifuge.nf @ 1:365849f031fd

"planemo upload"
author kkonganti
date Mon, 05 Jun 2023 18:48:51 -0400
parents
children
rev   line source
kkonganti@1 1 // Help text for centrifuge within CPIPES.
kkonganti@1 2
kkonganti@1 3 def centrifugeHelp(params) {
kkonganti@1 4
kkonganti@1 5 Map tool = [:]
kkonganti@1 6 Map toolspecs = [:]
kkonganti@1 7 tool.text = [:]
kkonganti@1 8 tool.helpparams = [:]
kkonganti@1 9
kkonganti@1 10 toolspecs = [
kkonganti@1 11 'centrifuge_x': [
kkonganti@1 12 clihelp: "Absolute path to centrifuge database. Default: ${params.centrifuge_x}",
kkonganti@1 13 cliflag: '-x',
kkonganti@1 14 clivalue: null
kkonganti@1 15 ],
kkonganti@1 16 'centrifuge_save_unaligned': [
kkonganti@1 17 clihelp: 'Save SINGLE-END reads that did not align. For PAIRED-END' +
kkonganti@1 18 " reads, save read pairs that did not align concordantly. Default: ${params.centrifuge_save_unaligned}",
kkonganti@1 19 cliflag: null, // Handled in modules logic.
kkonganti@1 20 clivalue: null
kkonganti@1 21 ],
kkonganti@1 22 'centrifuge_save_aligned': [
kkonganti@1 23 clihelp: 'Save SINGLE-END reads that aligned. For PAIRED-END' +
kkonganti@1 24 " reads, save read pairs that aligned concordantly. Default: ${params.centrifuge_save_aligned}",
kkonganti@1 25 cliflag: null, // Handled in modules logic.
kkonganti@1 26 clivalue: null
kkonganti@1 27 ],
kkonganti@1 28 'centrifuge_out_fmt_sam': [
kkonganti@1 29 clihelp: "Centrifuge output should be in SAM. Default: ${params.centrifuge_save_aligned}",
kkonganti@1 30 cliflag: null, // Handled in modules logic.
kkonganti@1 31 clivalue: null
kkonganti@1 32 ],
kkonganti@1 33 'centrifuge_extract_bug': [
kkonganti@1 34 clihelp: "Extract this bug from centrifuge results." +
kkonganti@1 35 " Default: ${params.centrifuge_extract_bug}",
kkonganti@1 36 cliflag: null, // Handled in modules logic.
kkonganti@1 37 clivalue: null,
kkonganti@1 38 ],
kkonganti@1 39 'centrifuge_ignore_quals': [
kkonganti@1 40 clihelp: 'Treat all quality values as 30 on Phred scale. ' +
kkonganti@1 41 "Default: ${params.centrifuge_ignore_quals}",
kkonganti@1 42 cliflag: '--ignore-quals',
kkonganti@1 43 clivalue: (params.centrifuge_ignore_quals ? ' ' : '')
kkonganti@1 44 ]
kkonganti@1 45 ]
kkonganti@1 46
kkonganti@1 47 toolspecs.each {
kkonganti@1 48 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1 49 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1 50 }
kkonganti@1 51
kkonganti@1 52 return tool
kkonganti@1 53 }
kkonganti@1 54