annotate 0.1.0/lib/help/guncrun.nf @ 2:408603fd75ca

"planemo upload"
author kkonganti
date Mon, 27 Nov 2023 14:21:42 -0500
parents c8597e9e1a97
children
rev   line source
kkonganti@0 1 // Help text for gunc run within CPIPES.
kkonganti@0 2
kkonganti@0 3 def guncrunHelp(params) {
kkonganti@0 4
kkonganti@0 5 Map tool = [:]
kkonganti@0 6 Map toolspecs = [:]
kkonganti@0 7 tool.text = [:]
kkonganti@0 8 tool.helpparams = [:]
kkonganti@0 9
kkonganti@0 10 toolspecs = [
kkonganti@0 11 'guncrun_run': [
kkonganti@0 12 clihelp: 'Run `gunc run` tool. Default: ' +
kkonganti@0 13 (params.guncrun_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'guncrun_in_is_fasta': [
kkonganti@0 18 clihelp: 'Is input a file in FASTA format. ' +
kkonganti@0 19 "Default: ${params.guncrun_in_is_fasta}",
kkonganti@0 20 cliflag: null,
kkonganti@0 21 clivalue: null
kkonganti@0 22 ],
kkonganti@0 23 'guncrun_in_is_fofn': [
kkonganti@0 24 clihelp: 'Is input a file of file names. ' +
kkonganti@0 25 "Default: ${params.guncrun_in_is_fofn}",
kkonganti@0 26 cliflag: null,
kkonganti@0 27 clivalue: null
kkonganti@0 28 ],
kkonganti@0 29 'guncrun_in_is_dir': [
kkonganti@0 30 clihelp: 'Is input a directory of FASTA files. ' +
kkonganti@0 31 "Default: ${params.guncrun_in_is_dir}",
kkonganti@0 32 cliflag: null,
kkonganti@0 33 clivalue: null
kkonganti@0 34 ],
kkonganti@0 35 'guncrun_file_suffix': [
kkonganti@0 36 clihelp: "Suffix of files if input is a directory. " +
kkonganti@0 37 "Default: ${params.guncrun_file_suffix}",
kkonganti@0 38 cliflag: '--file_suffix',
kkonganti@0 39 clivalue: (params.guncrun_file_suffix ?: '')
kkonganti@0 40 ],
kkonganti@0 41 'guncrun_gene_calls': [
kkonganti@0 42 clihelp: 'Input files are in FASTA faa format. ' +
kkonganti@0 43 "Default: ${params.guncrun_gene_calls}",
kkonganti@0 44 cliflag: '--gene_calls',
kkonganti@0 45 clivalue: (params.guncrun_gene_calls ? ' ' : '')
kkonganti@0 46 ],
kkonganti@0 47 'guncrun_temp_dir': [
kkonganti@0 48 clihelp: 'Path to directory to store temp files. ' +
kkonganti@0 49 "Default: ${params.guncrun_temp_dir}",
kkonganti@0 50 cliflag: '--temp_dir',
kkonganti@0 51 clivalue: (params.guncrun_temp_dir ?: '')
kkonganti@0 52 ],
kkonganti@0 53 'guncrun_sensitive': [
kkonganti@0 54 clihelp: 'Run with high sensitivity. ' +
kkonganti@0 55 "Default: ${params.guncrun_sensitive}",
kkonganti@0 56 cliflag: '--sensitive',
kkonganti@0 57 clivalue: (params.guncrun_sensitive ? ' ' : '')
kkonganti@0 58 ],
kkonganti@0 59 'guncrun_detailed_output': [
kkonganti@0 60 clihelp: 'Output scores for every taxa level. ' +
kkonganti@0 61 "Default: ${params.guncrun_detailed_output}",
kkonganti@0 62 cliflag: '--detailed_output',
kkonganti@0 63 clivalue: (params.guncrun_detailed_output ? ' ' : '')
kkonganti@0 64 ],
kkonganti@0 65 'guncrun_ctg_tax_output': [
kkonganti@0 66 clihelp: 'Output assignments for each contig. ' +
kkonganti@0 67 "Default: ${params.guncrun_ctg_tax_output}",
kkonganti@0 68 cliflag: '--contig_taxonomy_output',
kkonganti@0 69 clivalue: (params.guncrun_ctg_tax_output ? ' ' : '')
kkonganti@0 70 ],
kkonganti@0 71 'guncrun_use_species_lvl': [
kkonganti@0 72 clihelp: 'Allow species level to be picked as maxCSS. ' +
kkonganti@0 73 "Default: ${params.guncrun_use_species_lvl}",
kkonganti@0 74 cliflag: '--use_species_level',
kkonganti@0 75 clivalue: (params.guncrun_use_species_lvl ? ' ' : '')
kkonganti@0 76 ],
kkonganti@0 77 'guncrun_min_mapped_genes': [
kkonganti@0 78 clihelp: 'Do not calculate GUNC score if number of mapped ' +
kkonganti@0 79 'genes is below this value. ' +
kkonganti@0 80 "Default: ${params.guncrun_min_mapped_genes}",
kkonganti@0 81 cliflag: '--min_mapped_genes',
kkonganti@0 82 clivalue: (params.guncrun_min_mapped_genes ?: '')
kkonganti@0 83 ]
kkonganti@0 84 ]
kkonganti@0 85
kkonganti@0 86 toolspecs.each {
kkonganti@0 87 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 88 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 89 }
kkonganti@0 90
kkonganti@0 91 return tool
kkonganti@0 92 }