annotate 0.5.0/lib/help/kmaindex.nf @ 1:365849f031fd

"planemo upload"
author kkonganti
date Mon, 05 Jun 2023 18:48:51 -0400
parents
children
rev   line source
kkonganti@1 1 // Help text for kma index within CPIPES.
kkonganti@1 2
kkonganti@1 3 def kmaindexHelp(params) {
kkonganti@1 4
kkonganti@1 5 Map tool = [:]
kkonganti@1 6 Map toolspecs = [:]
kkonganti@1 7 tool.text = [:]
kkonganti@1 8 tool.helpparams = [:]
kkonganti@1 9
kkonganti@1 10 toolspecs = [
kkonganti@1 11 'kmaindex_run': [
kkonganti@1 12 clihelp: 'Run kma index tool. Default: ' +
kkonganti@1 13 (params.kmaindex_run ?: false),
kkonganti@1 14 cliflag: null,
kkonganti@1 15 clivalue: null
kkonganti@1 16 ],
kkonganti@1 17 'kmaindex_t_db': [
kkonganti@1 18 clihelp: 'Add to existing DB. ' +
kkonganti@1 19 "Default: ${params.kmaindex_t_db}",
kkonganti@1 20 cliflag: '-t_db',
kkonganti@1 21 clivalue: (params.kmaindex_t_db ? ' ' : '')
kkonganti@1 22 ],
kkonganti@1 23 'kmaindex_k': [
kkonganti@1 24 clihelp: 'k-mer size. ' +
kkonganti@1 25 "Default: ${params.kmaindex_k}",
kkonganti@1 26 cliflag: '-k',
kkonganti@1 27 clivalue: (params.kmaindex_k ?: '')
kkonganti@1 28 ],
kkonganti@1 29 'kmaindex_m': [
kkonganti@1 30 clihelp: 'Minimizer size. ' +
kkonganti@1 31 "Default: ${params.kmaindex_m}",
kkonganti@1 32 cliflag: '-m',
kkonganti@1 33 clivalue: (params.kmaindex_m ?: '')
kkonganti@1 34 ],
kkonganti@1 35 'kmaindex_hc': [
kkonganti@1 36 clihelp: 'Homopolymer compression. ' +
kkonganti@1 37 "Default: ${params.kmaindex_hc}",
kkonganti@1 38 cliflag: '-hc',
kkonganti@1 39 clivalue: (params.kmaindex_hc ? ' ' : '')
kkonganti@1 40 ],
kkonganti@1 41 'kmaindex_ML': [
kkonganti@1 42 clihelp: 'Minimum length of templates. Defaults to --kmaindex_k ' +
kkonganti@1 43 "Default: ${params.kmaindex_ML}",
kkonganti@1 44 cliflag: '-ML',
kkonganti@1 45 clivalue: (params.kmaindex_ML ?: '')
kkonganti@1 46 ],
kkonganti@1 47 'kmaindex_ME': [
kkonganti@1 48 clihelp: 'Mega DB. ' +
kkonganti@1 49 "Default: ${params.kmaindex_ME}",
kkonganti@1 50 cliflag: '-ME',
kkonganti@1 51 clivalue: (params.kmaindex_ME ? ' ' : '')
kkonganti@1 52 ],
kkonganti@1 53 'kmaindex_Sparse': [
kkonganti@1 54 clihelp: 'Make Sparse DB. ' +
kkonganti@1 55 "Default: ${params.kmaindex_Sparse}",
kkonganti@1 56 cliflag: '-Sparse',
kkonganti@1 57 clivalue: (params.kmaindex_Sparse ? ' ' : '')
kkonganti@1 58 ],
kkonganti@1 59 'kmaindex_ht': [
kkonganti@1 60 clihelp: 'Homology template. ' +
kkonganti@1 61 "Default: ${params.kmaindex_ht}",
kkonganti@1 62 cliflag: '-ht',
kkonganti@1 63 clivalue: (params.kmaindex_ht ?: '')
kkonganti@1 64 ],
kkonganti@1 65 'kmaindex_hq': [
kkonganti@1 66 clihelp: 'Homology query. ' +
kkonganti@1 67 "Default: ${params.kmaindex_hq}",
kkonganti@1 68 cliflag: '-hq',
kkonganti@1 69 clivalue: (params.kmaindex_hq ?: '')
kkonganti@1 70 ],
kkonganti@1 71 'kmaindex_and': [
kkonganti@1 72 clihelp: 'Both homology thresholds have to reach. ' +
kkonganti@1 73 "Default: ${params.kmaindex_and}",
kkonganti@1 74 cliflag: '-and',
kkonganti@1 75 clivalue: (params.kmaindex_and ? ' ' : '')
kkonganti@1 76 ],
kkonganti@1 77 'kmaindex_nbp': [
kkonganti@1 78 clihelp: 'No bias print. ' +
kkonganti@1 79 "Default: ${params.kmaindex_nbp}",
kkonganti@1 80 cliflag: '-nbp',
kkonganti@1 81 clivalue: (params.kmaindex_nbp ? ' ' : '')
kkonganti@1 82 ]
kkonganti@1 83 ]
kkonganti@1 84
kkonganti@1 85 toolspecs.each {
kkonganti@1 86 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1 87 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1 88 }
kkonganti@1 89
kkonganti@1 90 return tool
kkonganti@1 91 }