annotate 0.7.0/lib/help/tuspy.nf @ 17:0e7a0053e4a6

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