annotate 0.5.0/lib/help/flye.nf @ 1:365849f031fd

"planemo upload"
author kkonganti
date Mon, 05 Jun 2023 18:48:51 -0400
parents
children
rev   line source
kkonganti@1 1 // Help text for flye within CPIPES.
kkonganti@1 2
kkonganti@1 3 def flyeHelp(params) {
kkonganti@1 4
kkonganti@1 5 Map tool = [:]
kkonganti@1 6 Map toolspecs = [:]
kkonganti@1 7 tool.text = [:]
kkonganti@1 8 tool.helpparams = [:]
kkonganti@1 9
kkonganti@1 10 toolspecs = [
kkonganti@1 11 'flye_pacbio_raw': [
kkonganti@1 12 clihelp: 'Input FASTQ reads are PacBio regular CLR reads (<20% error) ' +
kkonganti@1 13 "Default: ${params.flye_pacbio_raw}",
kkonganti@1 14 cliflag: '--pacbio-raw',
kkonganti@1 15 clivalue: (params.flye_pacbio_raw ? ' ' : '')
kkonganti@1 16 ],
kkonganti@1 17 'flye_pacbio_corr': [
kkonganti@1 18 clihelp: 'Input FASTQ reads are PacBio reads that were corrected ' +
kkonganti@1 19 "with other methods (<3% error). Default: ${params.flye_pacbio_corr}",
kkonganti@1 20 cliflag: '--pacbio-corr',
kkonganti@1 21 clivalue: (params.flye_pacbio_corr ? ' ' : '')
kkonganti@1 22 ],
kkonganti@1 23 'flye_pacbio_hifi': [
kkonganti@1 24 clihelp: 'Input FASTQ reads are PacBio HiFi reads (<1% error). ' +
kkonganti@1 25 "Default: ${params.flye_pacbio_hifi}",
kkonganti@1 26 cliflag: '--pacbio-hifi',
kkonganti@1 27 clivalue: (params.flye_pacbio_hifi ? ' ' : '')
kkonganti@1 28 ],
kkonganti@1 29 'flye_nano_raw': [
kkonganti@1 30 clihelp: 'Input FASTQ reads are ONT regular reads, pre-Guppy5 (<20% error). ' +
kkonganti@1 31 "Default: ${params.flye_nano_raw}",
kkonganti@1 32 cliflag: '--nano-raw',
kkonganti@1 33 clivalue: (params.flye_nano_raw ? ' ' : '')
kkonganti@1 34 ],
kkonganti@1 35 'flye_nano_corr': [
kkonganti@1 36 clihelp: 'Input FASTQ reads are ONT reads that were corrected with other ' +
kkonganti@1 37 "methods (<3% error). Default: ${params.flye_nano_corr}",
kkonganti@1 38 cliflag: '--nano-corr',
kkonganti@1 39 clivalue: (params.flye_nano_corr ? ' ' : '')
kkonganti@1 40 ],
kkonganti@1 41 'flye_nano_hq': [
kkonganti@1 42 clihelp: 'Input FASTQ reads are ONT high-quality reads: ' +
kkonganti@1 43 "Guppy5+ SUP or Q20 (<5% error). Default: ${params.flye_nano_hq}",
kkonganti@1 44 cliflag: '--nano-hq',
kkonganti@1 45 clivalue: (params.flye_nano_hq ? ' ' : '')
kkonganti@1 46 ],
kkonganti@1 47 'flye_genome_size': [
kkonganti@1 48 clihelp: 'Estimated genome size (for example, 5m or 2.6g). ' +
kkonganti@1 49 "Default: ${params.flye_genome_size}",
kkonganti@1 50 cliflag: '--genome-size',
kkonganti@1 51 clivalue: (params.flye_genome_size ?: '')
kkonganti@1 52 ],
kkonganti@1 53 'flye_polish_iter': [
kkonganti@1 54 clihelp: 'Number of genome polishing iterations. ' +
kkonganti@1 55 "Default: ${params.flye_polish_iter}",
kkonganti@1 56 cliflag: '--iterations',
kkonganti@1 57 clivalue: (params.flye_polish_iter ?: '')
kkonganti@1 58 ],
kkonganti@1 59 'flye_meta': [
kkonganti@1 60 clihelp: "Do a metagenome assembly (unenven coverage mode). Default: ${params.flye_meta}",
kkonganti@1 61 cliflag: '--meta',
kkonganti@1 62 clivalue: (params.flye_meta ? ' ' : '')
kkonganti@1 63 ],
kkonganti@1 64 'flye_min_overlap': [
kkonganti@1 65 clihelp: "Minimum overlap between reads. Default: ${params.flye_min_overlap}",
kkonganti@1 66 cliflag: '--min-overlap',
kkonganti@1 67 clivalue: (params.flye_min_overlap ?: '')
kkonganti@1 68 ],
kkonganti@1 69 'flye_scaffold': [
kkonganti@1 70 clihelp: "Enable scaffolding using assembly graph. Default: ${params.flye_scaffold}",
kkonganti@1 71 cliflag: '--scaffold',
kkonganti@1 72 clivalue: (params.flye_scaffold ? ' ' : '')
kkonganti@1 73 ]
kkonganti@1 74 ]
kkonganti@1 75
kkonganti@1 76 toolspecs.each {
kkonganti@1 77 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1 78 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1 79 }
kkonganti@1 80
kkonganti@1 81 return tool
kkonganti@1 82 }