annotate 0.2.0/lib/help/dpubmlstpy.nf @ 15:7c0407ebbdf3

planemo upload
author kkonganti
date Mon, 15 Jul 2024 17:55:16 -0400
parents a5f31c44f8c9
children
rev   line source
kkonganti@11 1 // Help text for dl_pubmlst_profiles_and_schemes.py (dpubmlstpy) within CPIPES.
kkonganti@11 2
kkonganti@11 3 def dpubmlstpyHelp(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 'dpubmlstpy_run': [
kkonganti@11 12 clihelp: 'Run the dl_pubmlst_profiles_and_schemes.py ' +
kkonganti@11 13 'script. Default: ' +
kkonganti@11 14 (params.dpubmlstpy_run ?: false),
kkonganti@11 15 cliflag: null,
kkonganti@11 16 clivalue: null
kkonganti@11 17 ],
kkonganti@11 18 'dpubmlstpy_org': [
kkonganti@11 19 clihelp: 'The organism name to download the MLST alleles ' +
kkonganti@11 20 'FASTA and profile CSV for. ' +
kkonganti@11 21 " Default: ${params.dpubmlstpy_org}",
kkonganti@11 22 cliflag: '-org',
kkonganti@11 23 clivalue: (params.dpubmlstpy_org ?: '')
kkonganti@11 24 ],
kkonganti@11 25 'dpubmlstpy_mlsts': [
kkonganti@11 26 clihelp: 'The MLST scheme ID to download. ' +
kkonganti@11 27 " Default: ${params.dpubmlstpy_mlsts}",
kkonganti@11 28 cliflag: '-mlsts',
kkonganti@11 29 clivalue: (params.dpubmlstpy_mlsts ?: '')
kkonganti@11 30 ],
kkonganti@11 31 'dpubmlstpy_profile': [
kkonganti@11 32 clihelp: 'The MLST profile name in the scheme. ' +
kkonganti@11 33 " Default: ${params.dpubmlstpy_profile}",
kkonganti@11 34 cliflag: '-profile',
kkonganti@11 35 clivalue: (params.dpubmlstpy_profile ?: '')
kkonganti@11 36 ],
kkonganti@11 37 'dpubmlstpy_loci': [
kkonganti@11 38 clihelp: 'The key name in the JSON response which lists the ' +
kkonganti@11 39 'allele URLs to download. ' +
kkonganti@11 40 " Default: ${params.dpubmlstpy_loci}",
kkonganti@11 41 cliflag: '-loci',
kkonganti@11 42 clivalue: (params.dpubmlstpy_loci ?: '')
kkonganti@11 43 ],
kkonganti@11 44 'dpubmlstpy_suffix': [
kkonganti@11 45 clihelp: 'What should be the suffix of the downloaded allele ' +
kkonganti@11 46 'FASTA. ' +
kkonganti@11 47 " Default: ${params.dpubmlstpy_suffix}",
kkonganti@11 48 cliflag: '-suffix',
kkonganti@11 49 clivalue: (params.dpubmlstpy_suffix ?: '')
kkonganti@11 50 ],
kkonganti@11 51 'dpubmlstpy_akey': [
kkonganti@11 52 clihelp: 'What is the key in the JSON response that contains ' +
kkonganti@11 53 'the URL for allele FASTA. ' +
kkonganti@11 54 " Default: ${params.dpubmlstpy_akey}",
kkonganti@11 55 cliflag: '-akey',
kkonganti@11 56 clivalue: (params.dpubmlstpy_akey ?: '')
kkonganti@11 57 ],
kkonganti@11 58 'dpubmlstpy_id': [
kkonganti@11 59 clihelp: 'What is the key in the JSON response that contains ' +
kkonganti@11 60 'the name of the allele FASTA. ' +
kkonganti@11 61 " Default: ${params.dpubmlstpy_id}",
kkonganti@11 62 cliflag: '-id',
kkonganti@11 63 clivalue: (params.dpubmlstpy_id ?: '')
kkonganti@11 64 ]
kkonganti@11 65 ]
kkonganti@11 66
kkonganti@11 67 toolspecs.each {
kkonganti@11 68 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@11 69 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@11 70 }
kkonganti@11 71
kkonganti@11 72 return tool
kkonganti@11 73 }