annotate 0.2.0/lib/help/prokka.nf @ 11:a5f31c44f8c9

planemo upload
author kkonganti
date Mon, 15 Jul 2024 16:11:44 -0400
parents
children
rev   line source
kkonganti@11 1 // Help text for prokka within CPIPES.
kkonganti@11 2
kkonganti@11 3 def prokkaHelp(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 'prokka_run': [
kkonganti@11 12 clihelp: 'Run prokka tool. Default: ' +
kkonganti@11 13 (params.prokka_run ?: false),
kkonganti@11 14 cliflag: null,
kkonganti@11 15 clivalue: null
kkonganti@11 16 ],
kkonganti@11 17 'prokka_dbdir': [
kkonganti@11 18 clihelp: 'Path to prokka database root folder. ' +
kkonganti@11 19 "Default: ${params.prokka_dbdir}",
kkonganti@11 20 cliflag: '--dbdir',
kkonganti@11 21 clivalue: (params.prokka_dbdir ?: '')
kkonganti@11 22 ],
kkonganti@11 23 'prokka_addgenes': [
kkonganti@11 24 clihelp: "Add 'gene' features for each 'CDS' feature. " +
kkonganti@11 25 "Default: ${params.prokka_addgenes}",
kkonganti@11 26 cliflag: '--addgenes',
kkonganti@11 27 clivalue: (params.prokka_addgenes ? ' ' : '')
kkonganti@11 28 ],
kkonganti@11 29 'prokka_addmrna': [
kkonganti@11 30 clihelp: "Add 'mRNA' features for each 'CDS' feature. " +
kkonganti@11 31 "Default: ${params.prokka_addmrna}",
kkonganti@11 32 cliflag: '--addmrna',
kkonganti@11 33 clivalue: (params.prokka_addmrna ? ' ' : '')
kkonganti@11 34 ],
kkonganti@11 35 'prokka_locustag': [
kkonganti@11 36 clihelp: "Locus tag prefix. " +
kkonganti@11 37 "Default: ${params.prokka_locustag}",
kkonganti@11 38 cliflag: '--locustag',
kkonganti@11 39 clivalue: (params.prokka_locustag ?: '')
kkonganti@11 40 ],
kkonganti@11 41 'prokka_increment': [
kkonganti@11 42 clihelp: "Locus tag counter increment. " +
kkonganti@11 43 "Default: ${params.prokka_increment}",
kkonganti@11 44 cliflag: '--increment',
kkonganti@11 45 clivalue: (params.prokka_increment ?: '')
kkonganti@11 46 ],
kkonganti@11 47 'prokka_gffver': [
kkonganti@11 48 clihelp: 'GFF version. ' +
kkonganti@11 49 "Default: ${params.prokka_gffver}",
kkonganti@11 50 cliflag: '-gffver',
kkonganti@11 51 clivalue: (params.prokka_gffver ?: '')
kkonganti@11 52 ],
kkonganti@11 53 'prokka_compliant': [
kkonganti@11 54 clihelp: ' Force Genbank/ENA/DDJB compliance i.e. ' +
kkonganti@11 55 '--prokka_addgenes --prokka_mincontiglen 200 --prokka_centre XXX. ' +
kkonganti@11 56 "Default: ${params.prokka_compliant}",
kkonganti@11 57 cliflag: '--compliant',
kkonganti@11 58 clivalue: (params.prokka_compliant ? ' ' : '')
kkonganti@11 59 ],
kkonganti@11 60 'prokka_centre': [
kkonganti@11 61 clihelp: 'Sequencing centre ID. ' +
kkonganti@11 62 "Default: ${params.prokka_centre}",
kkonganti@11 63 cliflag: '--centre',
kkonganti@11 64 clivalue: (params.prokka_centre ?: '')
kkonganti@11 65 ],
kkonganti@11 66 'prokka_accver': [
kkonganti@11 67 clihelp: 'Version to put in GenBank file. ' +
kkonganti@11 68 "Default: ${params.prokka_accver}",
kkonganti@11 69 cliflag: '--accver',
kkonganti@11 70 clivalue: (params.prokka_accver ?: '')
kkonganti@11 71 ],
kkonganti@11 72 'prokka_genus': [
kkonganti@11 73 clihelp: 'Genus name. ' +
kkonganti@11 74 "Default: ${params.prokka_genus}",
kkonganti@11 75 cliflag: '--genus',
kkonganti@11 76 clivalue: (params.prokka_genus ?: '')
kkonganti@11 77 ],
kkonganti@11 78 'prokka_species': [
kkonganti@11 79 clihelp: 'Species name. ' +
kkonganti@11 80 "Default: ${params.prokka_species}",
kkonganti@11 81 cliflag: '--species',
kkonganti@11 82 clivalue: (params.prokka_species ?: '')
kkonganti@11 83 ],
kkonganti@11 84 'prokka_strain': [
kkonganti@11 85 clihelp: 'Strain name. ' +
kkonganti@11 86 "Default: ${params.prokka_strain}",
kkonganti@11 87 cliflag: '--strain',
kkonganti@11 88 clivalue: (params.prokka_strain ?: '')
kkonganti@11 89 ],
kkonganti@11 90 'prokka_plasmid': [
kkonganti@11 91 clihelp: 'Plasmid name or identifier. ' +
kkonganti@11 92 "Default: ${params.prokka_plasmid}",
kkonganti@11 93 cliflag: '--plasmid',
kkonganti@11 94 clivalue: (params.prokka_plasmid ?: '')
kkonganti@11 95 ],
kkonganti@11 96 'prokka_kingdom': [
kkonganti@11 97 clihelp: 'Annotation mode: Archaea|Bacteria|Mitochondria|Viruses. ' +
kkonganti@11 98 "Default: ${params.prokka_kingdom}",
kkonganti@11 99 cliflag: '--kingdom',
kkonganti@11 100 clivalue: (params.prokka_kingdom ?: '')
kkonganti@11 101 ],
kkonganti@11 102 'prokka_gcode': [
kkonganti@11 103 clihelp: 'Genetic code / Translation table (set if --prokka_kingdom is set). ' +
kkonganti@11 104 "Default: ${params.prokka_gcode}",
kkonganti@11 105 cliflag: '--gcode',
kkonganti@11 106 clivalue: (params.prokka_gcode ?: '')
kkonganti@11 107 ],
kkonganti@11 108 'prokka_usegenus': [
kkonganti@11 109 clihelp: 'Use genus-specific BLAST databases (needs --prokka_genus) ' +
kkonganti@11 110 "Default: ${params.prokka_usegenus}",
kkonganti@11 111 cliflag: '--usegenus',
kkonganti@11 112 clivalue: (params.prokka_usegenus ? ' ' : '')
kkonganti@11 113 ],
kkonganti@11 114 'prokka_metagenome': [
kkonganti@11 115 clihelp: 'Improve gene predictions for highly fragmented genomes. ' +
kkonganti@11 116 "Default: ${params.prokka_metagenome}",
kkonganti@11 117 cliflag: '--metagenome',
kkonganti@11 118 clivalue: (params.prokka_metagenome ? ' ' : '')
kkonganti@11 119 ],
kkonganti@11 120 'prokka_rawproduct': [
kkonganti@11 121 clihelp: 'Version to put in GenBank file. ' +
kkonganti@11 122 "Default: ${params.prokka_rawproduct}",
kkonganti@11 123 cliflag: '--rawproduct',
kkonganti@11 124 clivalue: (params.prokka_rawproduct ?: '')
kkonganti@11 125 ],
kkonganti@11 126 'prokka_cdsrnaolap': [
kkonganti@11 127 clihelp: 'Do not clean up /product annotation. ' +
kkonganti@11 128 "Default: ${params.prokka_cdsrnaolap}",
kkonganti@11 129 cliflag: '--cdsrnaolap',
kkonganti@11 130 clivalue: (params.prokka_cdsrnaolap ? ' ' : '')
kkonganti@11 131 ],
kkonganti@11 132 'prokka_evalue': [
kkonganti@11 133 clihelp: 'Similarity e-value cut-off. ' +
kkonganti@11 134 "Default: ${params.prokka_evalue}",
kkonganti@11 135 cliflag: '--evalue',
kkonganti@11 136 clivalue: (params.prokka_evalue ?: '')
kkonganti@11 137 ],
kkonganti@11 138 'prokka_coverage': [
kkonganti@11 139 clihelp: 'Minimum coverage on query protein. ' +
kkonganti@11 140 "Default: ${params.prokka_coverage}",
kkonganti@11 141 cliflag: '--coverage',
kkonganti@11 142 clivalue: (params.prokka_coverage ?: '')
kkonganti@11 143 ],
kkonganti@11 144 'prokka_fast': [
kkonganti@11 145 clihelp: 'Fast mode - only use basic BLASTP databases. ' +
kkonganti@11 146 "Default: ${params.prokka_fast}",
kkonganti@11 147 cliflag: '--fast',
kkonganti@11 148 clivalue: (params.prokka_fast ? ' ' : '')
kkonganti@11 149 ],
kkonganti@11 150 'prokka_noanno': [
kkonganti@11 151 clihelp: 'For CDS just set /product="unannotated protein". ' +
kkonganti@11 152 "Default: ${params.prokka_noanno}",
kkonganti@11 153 cliflag: '--noanno',
kkonganti@11 154 clivalue: (params.prokka_noanno ? ' ' : '')
kkonganti@11 155 ],
kkonganti@11 156 'prokka_mincontiglen': [
kkonganti@11 157 clihelp: 'Minimum contig size [NCBI needs 200]. ' +
kkonganti@11 158 "Default: ${params.prokka_mincontiglen}",
kkonganti@11 159 cliflag: '--mincontiglen',
kkonganti@11 160 clivalue: (params.prokka_mincontiglen ?: '')
kkonganti@11 161 ],
kkonganti@11 162 'prokka_rfam': [
kkonganti@11 163 clihelp: 'Enable searching for ncRNAs with Infernal+Rfam (SLOW!). ' +
kkonganti@11 164 "Default: ${params.prokka_rfam}",
kkonganti@11 165 cliflag: '--rfam',
kkonganti@11 166 clivalue: (params.prokka_rfam ? ' ' : '')
kkonganti@11 167 ],
kkonganti@11 168 'prokka_norrna': [
kkonganti@11 169 clihelp: "Don't run rRNA search. " +
kkonganti@11 170 "Default: ${params.prokka_norrna}",
kkonganti@11 171 cliflag: '--norrna',
kkonganti@11 172 clivalue: (params.prokka_norrna ? ' ' : '')
kkonganti@11 173 ],
kkonganti@11 174 'prokka_notrna': [
kkonganti@11 175 clihelp: "Don't run tRNA search. " +
kkonganti@11 176 "Default: ${params.prokka_notrna}",
kkonganti@11 177 cliflag: '--notrna',
kkonganti@11 178 clivalue: (params.prokka_notrna ? ' ' : '')
kkonganti@11 179 ],
kkonganti@11 180 'prokka_rnammer': [
kkonganti@11 181 clihelp: 'Prefer RNAmmer over Barrnap for rRNA prediction. ' +
kkonganti@11 182 "Default: ${params.prokka_rnammer}",
kkonganti@11 183 cliflag: '--rnammer',
kkonganti@11 184 clivalue: (params.prokka_rnammer ? ' ' : '')
kkonganti@11 185 ]
kkonganti@11 186 ]
kkonganti@11 187
kkonganti@11 188 toolspecs.each {
kkonganti@11 189 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@11 190 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@11 191 }
kkonganti@11 192
kkonganti@11 193 return tool
kkonganti@11 194 }