annotate 0.2.0/lib/help/checkm2predict.nf @ 16:bc5d019d2c3a

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