annotate 0.1.0/lib/help/checkm2predict.nf @ 7:f02f143c02fb

"planemo upload"
author kkonganti
date Mon, 27 Nov 2023 20:24:38 -0500
parents c8597e9e1a97
children
rev   line source
kkonganti@0 1 // Help text for checkm2 predict within CPIPES.
kkonganti@0 2
kkonganti@0 3 def checkm2predictHelp(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 'checkm2predict_run': [
kkonganti@0 12 clihelp: 'Run `checkm2 predict` tool. Default: ' +
kkonganti@0 13 (params.checkm2predict_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'checkm2predict_quiet': [
kkonganti@0 18 clihelp: 'Only output errors. ' +
kkonganti@0 19 "Default: ${params.checkm2predict_quiet}",
kkonganti@0 20 cliflag: '--quiet',
kkonganti@0 21 clivalue: (params.checkm2predict_quiet ? ' ' : '')
kkonganti@0 22 ],
kkonganti@0 23 'checkm2predict_lowmem': [
kkonganti@0 24 clihelp: 'Low memory mode. Reduces DIAMOND blocksize to ' +
kkonganti@0 25 'significantly reduce RAM usage at the expense of longer runtime. ' +
kkonganti@0 26 "Default: ${params.checkm2predict_lowmem}",
kkonganti@0 27 cliflag: '--lowmem',
kkonganti@0 28 clivalue: (params.checkm2predict_lowmem ? ' ' : '')
kkonganti@0 29 ],
kkonganti@0 30 'checkm2predict_general': [
kkonganti@0 31 clihelp: 'Force the use of the general quality prediction model (gradient boost). ' +
kkonganti@0 32 "Default: ${params.checkm2predict_general}",
kkonganti@0 33 cliflag: '--general',
kkonganti@0 34 clivalue: (params.checkm2predict_general ? ' ' : '')
kkonganti@0 35 ],
kkonganti@0 36 'checkm2predict_specific': [
kkonganti@0 37 clihelp: "Force the use of the specific quality prediction model (neural network) " +
kkonganti@0 38 "Default: ${params.checkm2predict_specific}",
kkonganti@0 39 cliflag: '--specific',
kkonganti@0 40 clivalue: (params.checkm2predict_specific ? ' ' : '')
kkonganti@0 41 ],
kkonganti@0 42 'checkm2predict_allmodels': [
kkonganti@0 43 clihelp: 'Output quality prediction for both models for each genome. ' +
kkonganti@0 44 "Default: ${params.checkm2predict_allmodels}",
kkonganti@0 45 cliflag: '--allmodels',
kkonganti@0 46 clivalue: (params.checkm2predict_allmodels ? ' ' : '')
kkonganti@0 47 ],
kkonganti@0 48 'checkm2predict_genes': [
kkonganti@0 49 clihelp: 'Treat input files as protein files. ' +
kkonganti@0 50 "Default: ${params.checkm2predict_genes}",
kkonganti@0 51 cliflag: '--genes',
kkonganti@0 52 clivalue: (params.checkm2predict_genes ? ' ' : '')
kkonganti@0 53 ],
kkonganti@0 54 'checkm2predict_x': [
kkonganti@0 55 clihelp: 'Extension of input files. ' +
kkonganti@0 56 "Default: ${params.checkm2predict_x}",
kkonganti@0 57 cliflag: '-x',
kkonganti@0 58 clivalue: (params.checkm2predict_x ?: '')
kkonganti@0 59 ],
kkonganti@0 60 'checkm2predict_tmpdir': [
kkonganti@0 61 clihelp: 'Specify an alternate directory for temporary files. ' +
kkonganti@0 62 "Default: ${params.checkm2predict_tmpdir}",
kkonganti@0 63 cliflag: '--tmpdir',
kkonganti@0 64 clivalue: (params.checkm2predict_tmpdir ?: '')
kkonganti@0 65 ],
kkonganti@0 66 'checkm2predict_rminterfiles': [
kkonganti@0 67 clihelp: 'Remove all intermediate files (protein files, diamond output). ' +
kkonganti@0 68 "Default: ${params.checkm2predict_rminterfiles}",
kkonganti@0 69 cliflag: '--remove_intermediates',
kkonganti@0 70 clivalue: (params.checkm2predict_rminterfiles ? ' ' : '')
kkonganti@0 71 ],
kkonganti@0 72 'checkm2predict_ttable': [
kkonganti@0 73 clihelp: 'Provide a specific progidal translation table for bins. The default ' +
kkonganti@0 74 'value of false will automatically determine either 11 or 4. ' +
kkonganti@0 75 "Default: ${params.checkm2predict_ttable}",
kkonganti@0 76 cliflag: '--ttable',
kkonganti@0 77 clivalue: (params.checkm2predict_ttable ? ' ' : '')
kkonganti@0 78 ],
kkonganti@0 79 'checkm2predict_dbg_cos': [
kkonganti@0 80 clihelp: 'DEBUG: Write cosine similarity values to a file. ' +
kkonganti@0 81 "Default: ${params.checkm2predict_dbg_cos}",
kkonganti@0 82 cliflag: '--dbg_cos',
kkonganti@0 83 clivalue: (params.checkm2predict_dbg_cos ? ' ' : '')
kkonganti@0 84 ],
kkonganti@0 85 'checkm2predict_dbg_vectors': [
kkonganti@0 86 clihelp: 'DEBUG: Write Dump pickled feature vectors to a file. ' +
kkonganti@0 87 "Default: ${params.checkm2predict_dbg_vectors}",
kkonganti@0 88 cliflag: '--dbg_vectors',
kkonganti@0 89 clivalue: (params.checkm2predict_dbg_vectors ? ' ' : '')
kkonganti@0 90 ]
kkonganti@0 91 ]
kkonganti@0 92
kkonganti@0 93 toolspecs.each {
kkonganti@0 94 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 95 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 96 }
kkonganti@0 97
kkonganti@0 98 return tool
kkonganti@0 99 }