annotate 0.6.1/lib/help/wcomp.nf @ 11:749faef1caa9

"planemo upload"
author kkonganti
date Tue, 05 Sep 2023 11:51:40 -0400
parents
children
rev   line source
kkonganti@11 1 // Help text for waterfall_per_computed_serotype.pl (wcomp) within CPIPES.
kkonganti@11 2
kkonganti@11 3 def wcompHelp(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 'wcomp_serocol': [
kkonganti@11 12 clihelp: 'Column number (non 0-based index) of the PDG metadata file ' +
kkonganti@11 13 'by which the serotypes are collected.' +
kkonganti@11 14 " Default: ${params.wcomp_serocol}",
kkonganti@11 15 cliflag: '--serocol',
kkonganti@11 16 clivalue: (params.wcomp_serocol ?: '')
kkonganti@11 17 ],
kkonganti@11 18 'wcomp_complete_sero': [
kkonganti@11 19 clihelp: 'Skip indexing serotypes when the serotype name in the column ' +
kkonganti@11 20 'number 49 (non 0-based) of PDG metadata file consists a "-". For example, if ' +
kkonganti@11 21 'an accession has a serotype= string as such in column ' +
kkonganti@11 22 'number 49 (non 0-based): ' +
kkonganti@11 23 '"serotype=- 13:z4,z23:-" ' +
kkonganti@11 24 'then, the indexing of that accession is skipped.' +
kkonganti@11 25 " Default: ${params.wcomp_complete_sero}",
kkonganti@11 26 cliflag: '--complete_serotype_name',
kkonganti@11 27 clivalue: (params.wcomp_complete_sero ? ' ' : '')
kkonganti@11 28 ],
kkonganti@11 29 'wcomp_not_null_serovar': [
kkonganti@11 30 clihelp: 'Only index the computed_serotype column ' +
kkonganti@11 31 'i.e. column number 49 (non 0-based), if the serovar column' +
kkonganti@11 32 ' is not NULL. ' +
kkonganti@11 33 " Default: ${params.wcomp_not_null_serovar}",
kkonganti@11 34 cliflag: '--not_null_serotype_name',
kkonganti@11 35 clivalue: (params.wcomp_not_null_serovar ?: '')
kkonganti@11 36 ],
kkonganti@11 37 'wcomp_i': [
kkonganti@11 38 clihelp: 'Force include this serovar. Ignores ' +
kkonganti@11 39 '--wcomp_complete_sero for only this serovar. ' +
kkonganti@11 40 'Mention multiple serovars separated by a ! (Exclamation mark). ' +
kkonganti@11 41 'Ex: --wcomp_complete_sero I 4,[5],12:i:-!Agona' +
kkonganti@11 42 " Default: ${params.wcomp_i}",
kkonganti@11 43 cliflag: '-i',
kkonganti@11 44 clivalue: (params.wcomp_i ? params.wcomp_i.split(/\!/).join(' -i ').trim().replace(/^\-i\s+/, '') : '')
kkonganti@11 45 ],
kkonganti@11 46 'wcomp_num': [
kkonganti@11 47 clihelp: 'Number of genome accessions to be collected per serotype.' +
kkonganti@11 48 " Default: ${params.wcomp_num}",
kkonganti@11 49 cliflag: '-num',
kkonganti@11 50 clivalue: (params.wcomp_num ?: '')
kkonganti@11 51 ],
kkonganti@11 52 'wcomp_min_contig_size': [
kkonganti@11 53 clihelp: 'Minimum contig size to consider a genome for indexing.' +
kkonganti@11 54 " Default: ${params.wcomp_min_contig_size}",
kkonganti@11 55 cliflag: '--min_contig_size',
kkonganti@11 56 clivalue: (params.wcomp_min_contig_size ?: '')
kkonganti@11 57 ]
kkonganti@11 58 ]
kkonganti@11 59
kkonganti@11 60 toolspecs.each {
kkonganti@11 61 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@11 62 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@11 63 }
kkonganti@11 64
kkonganti@11 65 return tool
kkonganti@11 66 }