annotate 0.6.1/lib/help/tuspy.nf @ 13:74baf1a6c3bd

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