annotate 0.2.1/lib/help/centrifuge.nf @ 0:77494b0fa3c7

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