annotate 0.6.1/lib/help/kmaindex.nf @ 15:1972677994a6

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