annotate 0.6.1/lib/help/centrifuge.nf @ 11:749faef1caa9

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