annotate 0.5.0/lib/help/tuspy.nf @ 1:365849f031fd

"planemo upload"
author kkonganti
date Mon, 05 Jun 2023 18:48:51 -0400
parents
children
rev   line source
kkonganti@1 1 // Help text for get_top_unique_mash_hit_genomes.py (tuspy) within CPIPES.
kkonganti@1 2
kkonganti@1 3 def tuspyHelp(params) {
kkonganti@1 4
kkonganti@1 5 Map tool = [:]
kkonganti@1 6 Map toolspecs = [:]
kkonganti@1 7 tool.text = [:]
kkonganti@1 8 tool.helpparams = [:]
kkonganti@1 9
kkonganti@1 10 toolspecs = [
kkonganti@1 11 'tuspy_run': [
kkonganti@1 12 clihelp: 'Run the get_top_unique_mash_hits_genomes.py ' +
kkonganti@1 13 'script. Default: ' +
kkonganti@1 14 (params.tuspy_run ?: false),
kkonganti@1 15 cliflag: null,
kkonganti@1 16 clivalue: null
kkonganti@1 17 ],
kkonganti@1 18 'tuspy_s': [
kkonganti@1 19 clihelp: 'Absolute UNIX path to metadata text file with the ' +
kkonganti@1 20 'field separator, | and ' +
kkonganti@1 21 '5 fields: serotype|asm_lvl|asm_url|snp_cluster_id' +
kkonganti@1 22 'Ex: serotype=Derby,antigen_formula=4:f,g:-|Scaffold|402440|ftp://...' +
kkonganti@1 23 '|PDS000096654.2. Mentioning this option will create a pickle file for the ' +
kkonganti@1 24 'provided metadata and exits.' +
kkonganti@1 25 " Default: ${params.tuspy_s}",
kkonganti@1 26 cliflag: '-s',
kkonganti@1 27 clivalue: (params.tuspy_s ?: '')
kkonganti@1 28 ],
kkonganti@1 29 'tuspy_m': [
kkonganti@1 30 clihelp: 'Absolute UNIX path to mash screen results file.' +
kkonganti@1 31 " Default: ${params.tuspy_m}",
kkonganti@1 32 cliflag: '-m',
kkonganti@1 33 clivalue: (params.tuspy_m ?: '')
kkonganti@1 34 ],
kkonganti@1 35 'tuspy_ps': [
kkonganti@1 36 clihelp: 'Absolute UNIX Path to serialized metadata object ' +
kkonganti@1 37 'in a pickle file.' +
kkonganti@1 38 " Default: ${params.tuspy_ps}",
kkonganti@1 39 cliflag: '-ps',
kkonganti@1 40 clivalue: (params.tuspy_ps ?: '')
kkonganti@1 41 ],
kkonganti@1 42 'tuspy_gd': [
kkonganti@1 43 clihelp: 'Absolute UNIX Path to directory containing ' +
kkonganti@1 44 'gzipped genome FASTA files.' +
kkonganti@1 45 " Default: ${params.tuspy_gd}",
kkonganti@1 46 cliflag: '-gd',
kkonganti@1 47 clivalue: (params.tuspy_gd ?: '')
kkonganti@1 48 ],
kkonganti@1 49 'tuspy_gds': [
kkonganti@1 50 clihelp: 'Genome FASTA file suffix to search for in the ' +
kkonganti@1 51 'genome directory.' +
kkonganti@1 52 " Default: ${params.tuspy_gds}",
kkonganti@1 53 cliflag: '-gds',
kkonganti@1 54 clivalue: (params.tuspy_gds ?: '')
kkonganti@1 55 ],
kkonganti@1 56 'tuspy_n': [
kkonganti@1 57 clihelp: 'Return up to this many number of top N unique ' +
kkonganti@1 58 'genome accession hits.' +
kkonganti@1 59 " Default: ${params.tuspy_n}",
kkonganti@1 60 cliflag: '-n',
kkonganti@1 61 clivalue: (params.tuspy_n ?: '')
kkonganti@1 62 ]
kkonganti@1 63 ]
kkonganti@1 64
kkonganti@1 65 toolspecs.each {
kkonganti@1 66 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1 67 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1 68 }
kkonganti@1 69
kkonganti@1 70 return tool
kkonganti@1 71 }