annotate 0.1.0/lib/help/shovill.nf @ 7:f02f143c02fb

"planemo upload"
author kkonganti
date Mon, 27 Nov 2023 20:24:38 -0500
parents c8597e9e1a97
children
rev   line source
kkonganti@0 1 // Help text for shovill within CPIPES.
kkonganti@0 2
kkonganti@0 3 def shovillHelp(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 'shovill_run': [
kkonganti@0 12 clihelp: 'Run shovill tool. Default: ' +
kkonganti@0 13 (params.shovill_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'shovill_depth': [
kkonganti@0 18 clihelp: 'Sub-sample R1/R2 to this depth. Disable with --shovill_depth 0. ' +
kkonganti@0 19 "Default: ${params.shovill_depth}",
kkonganti@0 20 cliflag: '--depth',
kkonganti@0 21 clivalue: (params.shovill_depth ?: 150)
kkonganti@0 22 ],
kkonganti@0 23 'shovill_gsize': [
kkonganti@0 24 clihelp: 'Estimated genome size eg. 3.2M. <false=AUTODETECT>. ' +
kkonganti@0 25 "Default: ${params.shovill_gsize}",
kkonganti@0 26 cliflag: '--gsize',
kkonganti@0 27 clivalue: (params.shovill_gsize ?: '')
kkonganti@0 28 ],
kkonganti@0 29 'shovill_minlen': [
kkonganti@0 30 clihelp: 'Minimum contig length. <false=AUTO>. ' +
kkonganti@0 31 "Default: ${params.shovill_minlen}",
kkonganti@0 32 cliflag: '--minlen',
kkonganti@0 33 clivalue: (params.shovill_minlen ?: '')
kkonganti@0 34 ],
kkonganti@0 35 'shovill_mincov': [
kkonganti@0 36 clihelp: "Minimum contig coverage. <false=AUTO>. " +
kkonganti@0 37 "Default: ${params.shovill_mincov}",
kkonganti@0 38 cliflag: '--mincov',
kkonganti@0 39 clivalue: (params.shovill_mincov ?: '')
kkonganti@0 40 ],
kkonganti@0 41 'shovill_namefmt': [
kkonganti@0 42 clihelp: "Format of contig FASTA IDs in 'printf' style. " +
kkonganti@0 43 "Default: ${params.shovill_namefmt}",
kkonganti@0 44 cliflag: '--namefmt',
kkonganti@0 45 clivalue: (params.shovill_namefmt ?: '')
kkonganti@0 46 ],
kkonganti@0 47 'shovill_keepfiles': [
kkonganti@0 48 clihelp: 'Keep intermediate files. ' +
kkonganti@0 49 "Default: ${params.shovill_keepfiles}",
kkonganti@0 50 cliflag: '--keepfiles',
kkonganti@0 51 clivalue: (params.shovill_keepfiles ? ' ' : '')
kkonganti@0 52 ],
kkonganti@0 53 'shovill_assembler': [
kkonganti@0 54 clihelp: 'Assembler: skesa, megahit, velvet, or spades. ' +
kkonganti@0 55 "Default: ${params.shovill_assembler}",
kkonganti@0 56 cliflag: '--assembler',
kkonganti@0 57 clivalue: (params.shovill_assembler ?: '')
kkonganti@0 58 ],
kkonganti@0 59 'shovill_opts': [
kkonganti@0 60 clihelp: "Extra assembler options in quotes. Ex: '--sc'. " +
kkonganti@0 61 "Default: ${params.shovill_opts}",
kkonganti@0 62 cliflag: '--opts',
kkonganti@0 63 clivalue: (params.shovill_opts ?: '')
kkonganti@0 64 ],
kkonganti@0 65 'shovill_kmers': [
kkonganti@0 66 clihelp: 'K-mers to use. <false=AUTO>. ' +
kkonganti@0 67 "Default: ${params.shovill_kmers}",
kkonganti@0 68 cliflag: '--kmers',
kkonganti@0 69 clivalue: (params.shovill_kmers ?: '')
kkonganti@0 70 ],
kkonganti@0 71 'shovill_trim': [
kkonganti@0 72 clihelp: 'Enable adator trimming. ' +
kkonganti@0 73 "Default: ${params.shovill_trim}",
kkonganti@0 74 cliflag: '--trim',
kkonganti@0 75 clivalue: (params.shovill_trim ? ' ' : '')
kkonganti@0 76 ],
kkonganti@0 77 'shovill_noreadcorr': [
kkonganti@0 78 clihelp: 'Disable read error correction. ' +
kkonganti@0 79 "Default: ${params.shovill_noreadcorr}",
kkonganti@0 80 cliflag: '--noreadcorr',
kkonganti@0 81 clivalue: (params.shovill_noreadcorr ? ' ' : '')
kkonganti@0 82 ],
kkonganti@0 83 'shovill_nostitch': [
kkonganti@0 84 clihelp: 'Disable read stitching. ' +
kkonganti@0 85 "Default: ${params.shovill_nostitch}",
kkonganti@0 86 cliflag: '--nostitch',
kkonganti@0 87 clivalue: (params.shovill_nostitch ? ' ' : '')
kkonganti@0 88 ],
kkonganti@0 89 'shovill_nocorr': [
kkonganti@0 90 clihelp: 'Disable post-assembly correction. ' +
kkonganti@0 91 "Default: ${params.shovill_nocorr}",
kkonganti@0 92 cliflag: '--nocorr',
kkonganti@0 93 clivalue: (params.shovill_nocorr ? ' ' : '')
kkonganti@0 94 ]
kkonganti@0 95 ]
kkonganti@0 96
kkonganti@0 97 toolspecs.each {
kkonganti@0 98 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 99 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 100 }
kkonganti@0 101
kkonganti@0 102 return tool
kkonganti@0 103 }