kkonganti@0: // Help text for gunc run within CPIPES.
kkonganti@0: 
kkonganti@0: def guncrunHelp(params) {
kkonganti@0: 
kkonganti@0:     Map tool = [:]
kkonganti@0:     Map toolspecs = [:]
kkonganti@0:     tool.text = [:]
kkonganti@0:     tool.helpparams = [:]
kkonganti@0: 
kkonganti@0:     toolspecs = [
kkonganti@0:         'guncrun_run': [
kkonganti@0:             clihelp: 'Run `gunc run` tool. Default: ' +
kkonganti@0:                 (params.guncrun_run ?: false),
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'guncrun_in_is_fasta': [
kkonganti@0:             clihelp: 'Is input a file in FASTA format. ' +
kkonganti@0:                 "Default: ${params.guncrun_in_is_fasta}",
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'guncrun_in_is_fofn': [
kkonganti@0:             clihelp: 'Is input a file of file names. ' +
kkonganti@0:                 "Default: ${params.guncrun_in_is_fofn}",
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'guncrun_in_is_dir': [
kkonganti@0:             clihelp: 'Is input a directory of FASTA files. ' +
kkonganti@0:                 "Default: ${params.guncrun_in_is_dir}",
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'guncrun_file_suffix': [
kkonganti@0:             clihelp: "Suffix of files if input is a directory. " +
kkonganti@0:                 "Default: ${params.guncrun_file_suffix}",
kkonganti@0:             cliflag: '--file_suffix',
kkonganti@0:             clivalue: (params.guncrun_file_suffix ?: '')
kkonganti@0:         ],
kkonganti@0:         'guncrun_gene_calls': [
kkonganti@0:             clihelp: 'Input files are in FASTA faa format. ' +
kkonganti@0:                 "Default: ${params.guncrun_gene_calls}",
kkonganti@0:             cliflag: '--gene_calls',
kkonganti@0:             clivalue: (params.guncrun_gene_calls ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'guncrun_temp_dir': [
kkonganti@0:             clihelp: 'Path to directory to store temp files. ' +
kkonganti@0:                 "Default: ${params.guncrun_temp_dir}",
kkonganti@0:             cliflag: '--temp_dir',
kkonganti@0:             clivalue: (params.guncrun_temp_dir ?: '')
kkonganti@0:         ],
kkonganti@0:         'guncrun_sensitive': [
kkonganti@0:             clihelp: 'Run with high sensitivity. ' +
kkonganti@0:                 "Default: ${params.guncrun_sensitive}",
kkonganti@0:             cliflag: '--sensitive',
kkonganti@0:             clivalue: (params.guncrun_sensitive ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'guncrun_detailed_output': [
kkonganti@0:             clihelp: 'Output scores for every taxa level. ' +
kkonganti@0:                 "Default: ${params.guncrun_detailed_output}",
kkonganti@0:             cliflag: '--detailed_output',
kkonganti@0:             clivalue: (params.guncrun_detailed_output ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'guncrun_ctg_tax_output': [
kkonganti@0:             clihelp: 'Output assignments for each contig. ' +
kkonganti@0:                 "Default: ${params.guncrun_ctg_tax_output}",
kkonganti@0:             cliflag: '--contig_taxonomy_output',
kkonganti@0:             clivalue: (params.guncrun_ctg_tax_output ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'guncrun_use_species_lvl': [
kkonganti@0:             clihelp: 'Allow species level to be picked as maxCSS. ' +
kkonganti@0:                 "Default: ${params.guncrun_use_species_lvl}",
kkonganti@0:             cliflag: '--use_species_level',
kkonganti@0:             clivalue: (params.guncrun_use_species_lvl ? ' ' : '')
kkonganti@0:         ],
kkonganti@0:         'guncrun_min_mapped_genes': [
kkonganti@0:             clihelp: 'Do not calculate GUNC score if number of mapped ' +
kkonganti@0:                 'genes is below this value. ' +
kkonganti@0:                 "Default: ${params.guncrun_min_mapped_genes}",
kkonganti@0:             cliflag: '--min_mapped_genes',
kkonganti@0:             clivalue: (params.guncrun_min_mapped_genes ?: '')
kkonganti@0:         ]
kkonganti@0:     ]
kkonganti@0: 
kkonganti@0:     toolspecs.each {
kkonganti@0:         k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0:         tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0:     }
kkonganti@0: 
kkonganti@0:     return tool
kkonganti@0: }