annotate 0.7.0/lib/help/centrifuge.nf @ 17:0e7a0053e4a6

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