Mercurial > repos > kkonganti > cfsan_cronology

annotate 0.2.0/lib/help/bbmerge.nf @ 18:a72c172df773 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload
author kkonganti
date Mon, 15 Jul 2024 21:40:42 -0400
parents a5f31c44f8c9
children
rev   line source
kkonganti@11 1 // Help text for bbmerge within CPIPES.
kkonganti@11 2
kkonganti@11 3 def bbmergeHelp(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 'bbmerge_run': [
kkonganti@11 12 clihelp: 'Run BBMerge tool. Default: ' +
kkonganti@11 13 (params.bbmerge_run ?: false),
kkonganti@11 14 cliflag: null,
kkonganti@11 15 clivalue: null
kkonganti@11 16 ],
kkonganti@11 17 'bbmerge_reads': [
kkonganti@11 18 clihelp: 'Quit after this many read pairs (-1 means all) ' +
kkonganti@11 19 <<<<<<< HEAD
kkonganti@11 20 "Defaut: ${params.bbmerge_reads}",
kkonganti@11 21 =======
kkonganti@11 22 "Default: ${params.bbmerge_reads}",
kkonganti@11 23 >>>>>>> 0.5.0
kkonganti@11 24 cliflag: 'reads=',
kkonganti@11 25 clivalue: (params.bbmerge_reads ?: '')
kkonganti@11 26 ],
kkonganti@11 27 'bbmerge_adapters': [
kkonganti@11 28 clihelp: 'Absolute UNIX path pointing to the adapters file in ' +
kkonganti@11 29 <<<<<<< HEAD
kkonganti@11 30 "FASTA format. Defaut: ${params.bbmerge_adapters}",
kkonganti@11 31 =======
kkonganti@11 32 "FASTA format. Default: ${params.bbmerge_adapters}",
kkonganti@11 33 >>>>>>> 0.5.0
kkonganti@11 34 cliflag: 'adapters=',
kkonganti@11 35 clivalue: (params.bbmerge_adapters ?: '')
kkonganti@11 36 ],
kkonganti@11 37 'bbmerge_ziplevel': [
kkonganti@11 38 clihelp: 'Set to 1 (lowest) through 9 (max) to change compression ' +
kkonganti@11 39 "level; lower compression is faster. Default: ${params.bbmerge_ziplevel}",
kkonganti@11 40 cliflag: 'ziplevel=',
kkonganti@11 41 clivalue: (params.bbmerge_ziplevel ?: '')
kkonganti@11 42 ],
kkonganti@11 43 'bbmerge_ordered': [
kkonganti@11 44 clihelp: 'Output reads in the same order as input. ' +
kkonganti@11 45 "Default: ${params.bbmerge_ordered}",
kkonganti@11 46 cliflag: 'ordered=',
kkonganti@11 47 clivalue: (params.bbmerge_ordered ?: '')
kkonganti@11 48 ],
kkonganti@11 49 'bbmerge_qtrim': [
kkonganti@11 50 clihelp: 'Trim read ends to remove bases with quality below --bbmerge_minq. ' +
kkonganti@11 51 'Trims BEFORE merging. Values: t (trim both ends), ' +
kkonganti@11 52 'f (neither end), r (right end only), l (left end only). ' +
kkonganti@11 53 "Default: ${params.bbmerge_qtrim}",
kkonganti@11 54 cliflag: 'qtrim=',
kkonganti@11 55 clivalue: (params.bbmerge_qtrim ?: '')
kkonganti@11 56 ],
kkonganti@11 57 'bbmerge_qtrim2': [
kkonganti@11 58 clihelp: 'May be specified instead of --bbmerge_qtrim to perform trimming ' +
kkonganti@11 59 'only if merging is unsuccesful. then retry merging. ' +
kkonganti@11 60 "Default: ${params.bbmerge_qtrim2}",
kkonganti@11 61 cliflag: 'qtrim2=',
kkonganti@11 62 clivalue: (params.bbmerge_qtrim2 ?: '')
kkonganti@11 63 ],
kkonganti@11 64 'bbmerge_trimq': [
kkonganti@11 65 clihelp: 'Trim quality threshold. This may be comma-delimited list (ascending) ' +
kkonganti@11 66 "to try multiple values. Default: ${params.bbmerge_trimq}",
kkonganti@11 67 cliflag: 'trimq=',
kkonganti@11 68 clivalue: (params.bbmerge_trimq ?: '')
kkonganti@11 69 ],
kkonganti@11 70 'bbmerge_minlength': [
kkonganti@11 71 clihelp: '(ml) Reads shorter than this after trimming, but before ' +
kkonganti@11 72 'merging, will be discarded. Pairs will be discarded only' +
kkonganti@11 73 "if both are shorter. Default: ${params.bbmerge_minlength}",
kkonganti@11 74 cliflag: 'minlength=',
kkonganti@11 75 clivalue: (params.bbmerge_minlength ?: '')
kkonganti@11 76 ],
kkonganti@11 77 'bbmerge_tbo': [
kkonganti@11 78 clihelp: '(trimbyoverlap). Trim overlapping reads to remove right ' +
kkonganti@11 79 "most (3') non-overlaping portion instead of joining " +
kkonganti@11 80 "Default: ${params.bbmerge_tbo}",
kkonganti@11 81 cliflag: 'tbo=',
kkonganti@11 82 clivalue: (params.bbmerge_tbo ?: '')
kkonganti@11 83 ],
kkonganti@11 84 'bbmerge_minavgquality': [
kkonganti@11 85 clihelp: '(maq). Reads with average quality below this after trimming will ' +
kkonganti@11 86 "not be attempted to merge. Default: ${params.bbmerge_minavgquality}",
kkonganti@11 87 cliflag: 'minavgquality=',
kkonganti@11 88 clivalue: (params.bbmerge_minavgquality ?: '')
kkonganti@11 89 ],
kkonganti@11 90 'bbmerge_trimpolya': [
kkonganti@11 91 clihelp: 'Trim trailing poly-A tail from adapter output. Only affects ' +
kkonganti@11 92 'outadapter. This also trims poly-A followed by poly-G, which ' +
kkonganti@11 93 "occurs on NextSeq. Default: ${params.bbmerge_trimpolya}",
kkonganti@11 94 cliflag: 'trimpolya=',
kkonganti@11 95 clivalue: (params.bbmerge_trimpolya ?: '')
kkonganti@11 96 ],
kkonganti@11 97 'bbmerge_pfilter': [
kkonganti@11 98 clihelp: 'Ban improbable overlaps. Higher is more strict. 0 will ' +
kkonganti@11 99 'disable the filter; 1 will allow only perfect overlaps. ' +
kkonganti@11 100 "Default: ${params.bbmerge_pfilter}",
kkonganti@11 101 cliflag: 'pfilter=',
kkonganti@11 102 clivalue: (params.bbmerge_pfilter ?: '')
kkonganti@11 103 ],
kkonganti@11 104 'bbmerge_ouq': [
kkonganti@11 105 clihelp: 'Calculate best overlap using quality values. ' +
kkonganti@11 106 "Default: ${params.bbmerge_ouq}",
kkonganti@11 107 cliflag: 'ouq',
kkonganti@11 108 clivalue: (params.bbmerge_ouq ?: '')
kkonganti@11 109 ],
kkonganti@11 110 'bbmerge_owq': [
kkonganti@11 111 clihelp: 'Calculate best overlap without using quality values. ' +
kkonganti@11 112 "Default: ${params.bbmerge_owq}",
kkonganti@11 113 cliflag: 'owq=',
kkonganti@11 114 clivalue: (params.bbmerge_owq ?: '')
kkonganti@11 115 ],
kkonganti@11 116 'bbmerge_strict': [
kkonganti@11 117 clihelp: 'Decrease false positive rate and merging rate. ' +
kkonganti@11 118 "Default: ${params.bbmerge_strict}",
kkonganti@11 119 cliflag: 'strict=',
kkonganti@11 120 clivalue: (params.bbmerge_strict ?: '')
kkonganti@11 121 ],
kkonganti@11 122 'bbmerge_verystrict': [
kkonganti@11 123 clihelp: 'Greatly decrease false positive rate and merging rate. ' +
kkonganti@11 124 "Default: ${params.bbmerge_verystrict}",
kkonganti@11 125 cliflag: 'verystrict=',
kkonganti@11 126 clivalue: (params.bbmerge_verystrict ?: '')
kkonganti@11 127 ],
kkonganti@11 128 'bbmerge_ultrastrict': [
kkonganti@11 129 clihelp: 'Decrease false positive rate and merging rate even more. ' +
kkonganti@11 130 "Default: ${params.bbmerge_ultrastrict}",
kkonganti@11 131 cliflag: 'ultrastrict=',
kkonganti@11 132 clivalue: (params.bbmerge_ultrastrict ?: '')
kkonganti@11 133 ],
kkonganti@11 134 'bbmerge_maxstrict': [
kkonganti@11 135 clihelp: 'Maxiamally decrease false positive rate and merging rate. ' +
kkonganti@11 136 "Default: ${params.bbmerge_maxstrict}",
kkonganti@11 137 cliflag: 'maxstrict=',
kkonganti@11 138 clivalue: (params.bbmerge_maxstrict ?: '')
kkonganti@11 139 ],
kkonganti@11 140 'bbmerge_loose': [
kkonganti@11 141 clihelp: 'Increase false positive rate and merging rate. ' +
kkonganti@11 142 "Default: ${params.bbmerge_loose}",
kkonganti@11 143 cliflag: 'loose=',
kkonganti@11 144 clivalue: (params.bbmerge_loose ?: '')
kkonganti@11 145 ],
kkonganti@11 146 'bbmerge_veryloose': [
kkonganti@11 147 clihelp: 'Greatly increase false positive rate and merging rate. ' +
kkonganti@11 148 "Default: ${params.bbmerge_veryloose}",
kkonganti@11 149 cliflag: 'veryloose=',
kkonganti@11 150 clivalue: (params.bbmerge_veryloose ?: '')
kkonganti@11 151 ],
kkonganti@11 152 'bbmerge_ultraloose': [
kkonganti@11 153 clihelp: 'Increase false positive rate and merging rate even more. ' +
kkonganti@11 154 "Default: ${params.bbmerge_ultraloose}",
kkonganti@11 155 cliflag: 'ultraloose=',
kkonganti@11 156 clivalue: (params.bbmerge_ultraloose ?: '')
kkonganti@11 157 ],
kkonganti@11 158 'bbmerge_maxloose': [
kkonganti@11 159 clihelp: 'Maximally increase false positive rate and merging rate. ' +
kkonganti@11 160 "Default: ${params.bbmerge_maxloose}",
kkonganti@11 161 cliflag: 'maxloose=',
kkonganti@11 162 clivalue: (params.bbmerge_maxloose ?: '')
kkonganti@11 163 ],
kkonganti@11 164 'bbmerge_fast': [
kkonganti@11 165 clihelp: 'Fastest possible preset. ' +
kkonganti@11 166 "Default: ${params.bbmerge_fast}",
kkonganti@11 167 cliflag: 'fast=',
kkonganti@11 168 clivalue: (params.bbmerge_fast ?: '')
kkonganti@11 169 ],
kkonganti@11 170 'bbmerge_k': [
kkonganti@11 171 clihelp: 'Kmer length. 31 (or less) is fastest and uses the least ' +
kkonganti@11 172 'memory, but higher values may be more accurate. ' +
kkonganti@11 173 '60 tends to work well for 150bp reads. ' +
kkonganti@11 174 "Default: ${params.bbmerge_k}",
kkonganti@11 175 cliflag: 'k=',
kkonganti@11 176 clivalue: (params.bbmerge_k ?: '')
kkonganti@11 177 ],
kkonganti@11 178 'bbmerge_prealloc': [
kkonganti@11 179 clihelp: 'Pre-allocate memory rather than dynamically growing. ' +
kkonganti@11 180 'Faster and more memory-efficient for large datasets. ' +
kkonganti@11 181 'A float fraction (0-1) may be specified, default 1. ' +
kkonganti@11 182 "Default: ${params.bbmerge_prealloc}",
kkonganti@11 183 cliflag: 'prealloc=',
kkonganti@11 184 clivalue: (params.bbmerge_prealloc ?: '')
kkonganti@11 185 ]
kkonganti@11 186 ]
kkonganti@11 187
kkonganti@11 188 toolspecs.each {
kkonganti@11 189 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@11 190 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@11 191 }
kkonganti@11 192
kkonganti@11 193 return tool
kkonganti@11 194 }