kkonganti@1: // Help text for waterfall_per_snp_cluster.pl (wsnp) within CPIPES.
kkonganti@1: 
kkonganti@1: def wsnpHelp(params) {
kkonganti@1: 
kkonganti@1:     Map tool = [:]
kkonganti@1:     Map toolspecs = [:]
kkonganti@1:     tool.text = [:]
kkonganti@1:     tool.helpparams = [:]
kkonganti@1: 
kkonganti@1:     toolspecs = [
kkonganti@1:         'wsnp_serocol': [
kkonganti@1:             clihelp: 'Column number (non 0-based index) of the PDG metadata file ' +
kkonganti@1:                 'by which the serotypes are collected.' +
kkonganti@1:                 " Default: ${params.wsnp_serocol}",
kkonganti@1:             cliflag: '--serocol',
kkonganti@1:             clivalue: (params.wsnp_serocol ?: '')
kkonganti@1:         ],
kkonganti@1:         'wsnp_complete_sero': [
kkonganti@1:             clihelp: 'Skip indexing serotypes when the serotype name in the column ' +
kkonganti@1:                 'number 49 (non 0-based) of PDG metadata file consists a "-". For example, if ' +
kkonganti@1:                 'an accession has a serotype= string as such in column ' +
kkonganti@1:                 'number 49 (non 0-based): ' +
kkonganti@1:                 '"serotype=- 13:z4,z23:-" ' +
kkonganti@1:                 'then, the indexing of that accession is skipped.' +
kkonganti@1:                 " Default: ${params.wsnp_complete_sero}",
kkonganti@1:             cliflag: '--complete_serotype_name',
kkonganti@1:             clivalue: (params.wsnp_complete_sero ? ' ' : '')
kkonganti@1:         ],
kkonganti@1:         'wsnp_not_null_serovar': [
kkonganti@1:             clihelp: 'Only index the computed_serotype column ' +
kkonganti@1:                 'i.e. column number 49 (non 0-based), if the serovar column' +
kkonganti@1:                 ' is not NULL. ' +
kkonganti@1:                 " Default: ${params.wsnp_not_null_serovar}",
kkonganti@1:             cliflag: '--not_null_serotype_name',
kkonganti@1:             clivalue: (params.wsnp_not_null_serovar ?: '')
kkonganti@1:         ],
kkonganti@1:         'wsnp_i': [
kkonganti@1:             clihelp: 'Force include this serovar. Ignores ' +
kkonganti@1:                 '--wsnp_complete_sero for only this serovar. ' +
kkonganti@1:                 'Mention multiple serovars separated by a ! (Exclamation mark). ' +
kkonganti@1:                 'Ex: --wsnp_complete_sero I 4,[5],12:i:-!Agona' +
kkonganti@1:                 " Default: ${params.wsnp_i}",
kkonganti@1:             cliflag: '-i',
kkonganti@1:             clivalue: (params.wsnp_i ? params.wsnp_i.split(/\!/).join(' -i ').trim().replace(/^\-i\s+/, '') : '')
kkonganti@1:         ],
kkonganti@1:         'wsnp_num': [
kkonganti@1:             clihelp: 'Number of genome accessions to collect per SNP cluster.' +
kkonganti@1:                 " Default: ${params.wsnp_num}",
kkonganti@1:             cliflag: '-num',
kkonganti@1:             clivalue: (params.wsnp_num ?: '')
kkonganti@1:         ]
kkonganti@1:     ]
kkonganti@1: 
kkonganti@1:     toolspecs.each {
kkonganti@1:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1:     }
kkonganti@1: 
kkonganti@1:     return tool
kkonganti@1: }