annotate 0.3.0/lib/help/centrifuge.nf @ 92:295c2597a475

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