annotate 0.2.0/lib/help/shovill.nf @ 17:b571995ddb51

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