annotate 0.7.0/lib/help/kmaindex.nf @ 21:4ce0e079377d tip

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