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