kkonganti@0: // Help text for dl_pubmlst_profiles_and_schemes.py (dpubmlstpy) within CPIPES.
kkonganti@0: 
kkonganti@0: def dpubmlstpyHelp(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:         'dpubmlstpy_run': [
kkonganti@0:             clihelp: 'Run the dl_pubmlst_profiles_and_schemes.py ' +
kkonganti@0:                 'script. Default: ' +
kkonganti@0:                 (params.dpubmlstpy_run ?: false),
kkonganti@0:             cliflag: null,
kkonganti@0:             clivalue: null
kkonganti@0:         ],
kkonganti@0:         'dpubmlstpy_org': [
kkonganti@0:             clihelp: 'The organism name to download the MLST alleles ' +
kkonganti@0:                 'FASTA and profile CSV for. ' +
kkonganti@0:                 " Default: ${params.dpubmlstpy_org}",
kkonganti@0:             cliflag: '-org',
kkonganti@0:             clivalue: (params.dpubmlstpy_org ?: '')
kkonganti@0:         ],
kkonganti@0:         'dpubmlstpy_mlsts': [
kkonganti@0:             clihelp: 'The MLST scheme ID to download. ' +
kkonganti@0:                 " Default: ${params.dpubmlstpy_mlsts}",
kkonganti@0:             cliflag: '-mlsts',
kkonganti@0:             clivalue: (params.dpubmlstpy_mlsts ?: '')
kkonganti@0:         ],
kkonganti@0:         'dpubmlstpy_profile': [
kkonganti@0:             clihelp: 'The MLST profile name in the scheme. ' +
kkonganti@0:                 " Default: ${params.dpubmlstpy_profile}",
kkonganti@0:             cliflag: '-profile',
kkonganti@0:             clivalue: (params.dpubmlstpy_profile ?: '')
kkonganti@0:         ],
kkonganti@0:         'dpubmlstpy_loci': [
kkonganti@0:             clihelp: 'The key name in the JSON response which lists the ' +
kkonganti@0:                 'allele URLs to download. ' +
kkonganti@0:                 " Default: ${params.dpubmlstpy_loci}",
kkonganti@0:             cliflag: '-loci',
kkonganti@0:             clivalue: (params.dpubmlstpy_loci ?: '')
kkonganti@0:         ],
kkonganti@0:         'dpubmlstpy_suffix': [
kkonganti@0:             clihelp: 'What should be the suffix of the downloaded allele ' +
kkonganti@0:                 'FASTA. ' +
kkonganti@0:                 " Default: ${params.dpubmlstpy_suffix}",
kkonganti@0:             cliflag: '-suffix',
kkonganti@0:             clivalue: (params.dpubmlstpy_suffix ?: '')
kkonganti@0:         ],
kkonganti@0:         'dpubmlstpy_akey': [
kkonganti@0:             clihelp: 'What is the key in the JSON response that contains ' +
kkonganti@0:                 'the URL for allele FASTA. ' +
kkonganti@0:                 " Default: ${params.dpubmlstpy_akey}",
kkonganti@0:             cliflag: '-akey',
kkonganti@0:             clivalue: (params.dpubmlstpy_akey ?: '')
kkonganti@0:         ],
kkonganti@0:         'dpubmlstpy_id': [
kkonganti@0:             clihelp: 'What is the key in the JSON response that contains ' +
kkonganti@0:                 'the name of the allele FASTA. ' +
kkonganti@0:                 " Default: ${params.dpubmlstpy_id}",
kkonganti@0:             cliflag: '-id',
kkonganti@0:             clivalue: (params.dpubmlstpy_id ?: '')
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: }