annotate 0.7.0/lib/help/megahit.nf @ 21:4ce0e079377d tip

planemo upload
author kkonganti
date Mon, 15 Jul 2024 12:01:00 -0400
parents 0e7a0053e4a6
children
rev   line source
kkonganti@17 1 // Help text for megahit within CPIPES.
kkonganti@17 2
kkonganti@17 3 def megahitHelp(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 'megahit_run': [
kkonganti@17 12 clihelp: 'Run MEGAHIT assembler. Default: ' +
kkonganti@17 13 (params.megahit_run ?: false),
kkonganti@17 14 cliflag: null,
kkonganti@17 15 clivalue: null
kkonganti@17 16 ],
kkonganti@17 17 'megahit_min_count': [
kkonganti@17 18 clihelp: '<int>. Minimum multiplicity for filtering (k_min+1)-mers. ' +
kkonganti@17 19 "Default: ${params.megahit_min_count}",
kkonganti@17 20 cliflag: '--min-count',
kkonganti@17 21 clivalue: (params.megahit_min_count ?: '')
kkonganti@17 22 ],
kkonganti@17 23 'megahit_k_list': [
kkonganti@17 24 clihelp: 'Comma-separated list of kmer size. All values must be odd, in ' +
kkonganti@17 25 "the range 15-255, increment should be <= 28. Ex: '21,29,39,59,79,99,119,141'. " +
kkonganti@17 26 "Default: ${params.megahit_k_list}",
kkonganti@17 27 cliflag: '--k-list',
kkonganti@17 28 clivalue: (params.megahit_k_list ?: '')
kkonganti@17 29 ],
kkonganti@17 30 'megahit_no_mercy': [
kkonganti@17 31 clihelp: 'Do not add mercy k-mers. ' +
kkonganti@17 32 "Default: ${params.megahit_no_mercy}",
kkonganti@17 33 cliflag: '--no-mercy',
kkonganti@17 34 clivalue: (params.megahit_no_mercy ? ' ' : '')
kkonganti@17 35 ],
kkonganti@17 36 'megahit_bubble_level': [
kkonganti@17 37 clihelp: '<int>. Intensity of bubble merging (0-2), 0 to disable. ' +
kkonganti@17 38 "Default: ${params.megahit_bubble_level}",
kkonganti@17 39 cliflag: '--bubble-level',
kkonganti@17 40 clivalue: (params.megahit_bubble_level ?: '')
kkonganti@17 41 ],
kkonganti@17 42 'megahit_merge_level': [
kkonganti@17 43 clihelp: '<l,s>. Merge complex bubbles of length <= l*kmer_size and ' +
kkonganti@17 44 "similarity >= s. Default: ${params.megahit_merge_level}",
kkonganti@17 45 cliflag: '--merge-level',
kkonganti@17 46 clivalue: (params.megahit_merge_level ?: '')
kkonganti@17 47 ],
kkonganti@17 48 'megahit_prune_level': [
kkonganti@17 49 clihelp: '<int>. Strength of low depth pruning (0-3). ' +
kkonganti@17 50 "Default: ${params.megahit_prune_level}",
kkonganti@17 51 cliflag: '--prune-level',
kkonganti@17 52 clivalue: (params.megahit_prune_level ?: '')
kkonganti@17 53 ],
kkonganti@17 54 'megahit_prune_depth': [
kkonganti@17 55 clihelp: '<int>. Remove unitigs with avg k-mer depth less than this value. ' +
kkonganti@17 56 "Default: ${params.megahit_prune_depth}",
kkonganti@17 57 cliflag: '--prune-depth',
kkonganti@17 58 clivalue: (params.megahit_prune_depth ?: '')
kkonganti@17 59 ],
kkonganti@17 60 'megahit_low_local_ratio': [
kkonganti@17 61 clihelp: '<float>. Ratio threshold to define low local coverage contigs. ' +
kkonganti@17 62 "Default: ${params.megahit_low_local_ratio}",
kkonganti@17 63 cliflag: '--low-local-ratio',
kkonganti@17 64 clivalue: (params.megahit_low_local_ratio ?: '')
kkonganti@17 65 ],
kkonganti@17 66 'megahit_max_tip_len': [
kkonganti@17 67 clihelp: '<int>. remove tips less than this value [<int> * k]. ' +
kkonganti@17 68 "Default: ${params.megahit_max_tip_len}",
kkonganti@17 69 cliflag: '--max-tip-len',
kkonganti@17 70 clivalue: (params.megahit_max_tip_len ?: '')
kkonganti@17 71 ],
kkonganti@17 72 'megahit_no_local': [
kkonganti@17 73 clihelp: 'Disable local assembly. ' +
kkonganti@17 74 "Default: ${params.megahit_no_local}",
kkonganti@17 75 cliflag: '--no-local',
kkonganti@17 76 clivalue: (params.megahit_no_local ? ' ' : '')
kkonganti@17 77 ],
kkonganti@17 78 'megahit_kmin_1pass': [
kkonganti@17 79 clihelp: 'Use 1pass mode to build SdBG of k_min. ' +
kkonganti@17 80 "Default: ${params.megahit_kmin_1pass}",
kkonganti@17 81 cliflag: '--kmin-1pass',
kkonganti@17 82 clivalue: (params.megahit_kmin_1pass ? ' ' : '')
kkonganti@17 83 ],
kkonganti@17 84 'megahit_preset': [
kkonganti@17 85 clihelp: '<str>. Override a group of parameters. Valid values are '+
kkonganti@17 86 "meta-sensitive which enforces '--min-count 1 --k-list 21,29,39,49,...,129,141', " +
kkonganti@17 87 'meta-large (large & complex metagenomes, like soil) which enforces ' +
kkonganti@17 88 "'--k-min 27 --k-max 127 --k-step 10'. " +
kkonganti@17 89 "Default: ${params.megahit_preset}",
kkonganti@17 90 cliflag: '--preset',
kkonganti@17 91 clivalue: (params.megahit_preset ?: '')
kkonganti@17 92 ],
kkonganti@17 93 'megahit_mem_flag': [
kkonganti@17 94 clihelp: '<int>. SdBG builder memory mode. 0: minimum; 1: moderate; 2: use all memory specified. ' +
kkonganti@17 95 "Default: ${params.megahit_mem_flag}",
kkonganti@17 96 cliflag: '--mem-flag',
kkonganti@17 97 clivalue: (params.megahit_mem_flag ?: '')
kkonganti@17 98 ],
kkonganti@17 99 'megahit_min_contig_len': [
kkonganti@17 100 clihelp: '<int>. Minimum length of contigs to output. ' +
kkonganti@17 101 "Default: ${params.megahit_min_contig_len}",
kkonganti@17 102 cliflag: '--use-gpu',
kkonganti@17 103 clivalue: (params.megahit_min_contig_len ?: '')
kkonganti@17 104 ]
kkonganti@17 105 ]
kkonganti@17 106
kkonganti@17 107 toolspecs.each {
kkonganti@17 108 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@17 109 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@17 110 }
kkonganti@17 111
kkonganti@17 112 return tool
kkonganti@17 113 }