annotate 0.1.0/lib/help/spades.nf @ 6:a3c1cba6f773

"planemo upload"
author kkonganti
date Mon, 27 Nov 2023 19:52:20 -0500
parents c8597e9e1a97
children
rev   line source
kkonganti@0 1 // Help text for spades within CPIPES.
kkonganti@0 2
kkonganti@0 3 def spadesHelp(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 'spades_run': [
kkonganti@0 12 clihelp: 'Run SPAdes assembler. Default: ' +
kkonganti@0 13 (params.spades_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'spades_isolate': [
kkonganti@0 18 clihelp: 'This flag is highly recommended for high-coverage isolate and ' +
kkonganti@0 19 "multi-cell data. Default: ${params.spades_isolate}",
kkonganti@0 20 cliflag: '--isolate',
kkonganti@0 21 clivalue: (params.spades_isolate ? ' ' : '')
kkonganti@0 22 ],
kkonganti@0 23 'spades_sc': [
kkonganti@0 24 clihelp: 'This flag is required for MDA (single-cell) data. ' +
kkonganti@0 25 "Default: ${params.spades_sc}",
kkonganti@0 26 cliflag: '--sc',
kkonganti@0 27 clivalue: (params.spades_sc ? ' ' : '')
kkonganti@0 28 ],
kkonganti@0 29 'spades_meta': [
kkonganti@0 30 clihelp: 'This flag is required for metagenomic data. ' +
kkonganti@0 31 "Default: ${params.spades_meta}",
kkonganti@0 32 cliflag: '--meta',
kkonganti@0 33 clivalue: (params.spades_meta ? ' ' : '')
kkonganti@0 34 ],
kkonganti@0 35 'spades_bio': [
kkonganti@0 36 clihelp: 'This flag is required for biosytheticSPAdes mode. ' +
kkonganti@0 37 "Default: ${params.spades_bio}",
kkonganti@0 38 cliflag: '--bio',
kkonganti@0 39 clivalue: (params.spades_bio ? ' ' : '')
kkonganti@0 40 ],
kkonganti@0 41 'spades_corona': [
kkonganti@0 42 clihelp: 'This flag is required for coronaSPAdes mode. ' +
kkonganti@0 43 "Default: ${params.spades_corona}",
kkonganti@0 44 cliflag: '--corona',
kkonganti@0 45 clivalue: (params.spades_corona ? ' ' : '')
kkonganti@0 46 ],
kkonganti@0 47 'spades_rna': [
kkonganti@0 48 clihelp: 'This flag is required for RNA-Seq data. ' +
kkonganti@0 49 "Default: ${params.spades_rna}",
kkonganti@0 50 cliflag: '--rna',
kkonganti@0 51 clivalue: (params.spades_rna ? ' ' : '')
kkonganti@0 52 ],
kkonganti@0 53 'spades_plasmid': [
kkonganti@0 54 clihelp: 'Runs plasmidSPAdes pipeline for plasmid detection. ' +
kkonganti@0 55 "Default: ${params.spades_plasmid}",
kkonganti@0 56 cliflag: '--plasmid',
kkonganti@0 57 clivalue: (params.spades_plasmid ? ' ' : '')
kkonganti@0 58 ],
kkonganti@0 59 'spades_metaviral': [
kkonganti@0 60 clihelp: 'Runs metaviralSPAdes pipeline for virus detection. ' +
kkonganti@0 61 "Default: ${params.spades_metaviral}",
kkonganti@0 62 cliflag: '--metaviral',
kkonganti@0 63 clivalue: (params.spades_metaviral ? ' ' : '')
kkonganti@0 64 ],
kkonganti@0 65 'spades_metaplasmid': [
kkonganti@0 66 clihelp: 'Runs metaplasmidSPAdes pipeline for plasmid detection in ' +
kkonganti@0 67 "metagenomics datasets. Default: ${params.spades_metaplasmid}",
kkonganti@0 68 cliflag: '--metaplasmid',
kkonganti@0 69 clivalue: (params.spades_metaplasmid ? ' ' : '')
kkonganti@0 70 ],
kkonganti@0 71 'spades_rnaviral': [
kkonganti@0 72 clihelp: 'This flag enables virus assembly module from RNA-Seq data. ' +
kkonganti@0 73 "Default: ${params.spades_rnaviral}",
kkonganti@0 74 cliflag: '--rnaviral',
kkonganti@0 75 clivalue: (params.spades_rnaviral ? ' ' : '')
kkonganti@0 76 ],
kkonganti@0 77 'spades_iontorrent': [
kkonganti@0 78 clihelp: 'This flag is required for IonTorrent data. ' +
kkonganti@0 79 "Default: ${params.spades_iontorrent}",
kkonganti@0 80 cliflag: '--iontorrent',
kkonganti@0 81 clivalue: (params.spades_iontorrent ? ' ' : '')
kkonganti@0 82 ],
kkonganti@0 83 'spades_only_assembler': [
kkonganti@0 84 clihelp: 'Runs only the SPAdes assembler module (without read error correction). ' +
kkonganti@0 85 "Default: ${params.spades_only_assembler}",
kkonganti@0 86 cliflag: '--only-assembler',
kkonganti@0 87 clivalue: (params.spades_only_assembler ? ' ' : '')
kkonganti@0 88 ],
kkonganti@0 89 'spades_careful': [
kkonganti@0 90 clihelp: 'Tries to reduce the number of mismatches and short indels in the assembly. ' +
kkonganti@0 91 "Default: ${params.spades_careful}",
kkonganti@0 92 cliflag: '--careful',
kkonganti@0 93 clivalue: (params.spades_careful ? ' ' : '')
kkonganti@0 94 ],
kkonganti@0 95 'spades_cov_cutoff': [
kkonganti@0 96 clihelp: 'Coverage cutoff value (a positive float number). ' +
kkonganti@0 97 "Default: ${params.spades_cov_cutoff}",
kkonganti@0 98 cliflag: '--cov-cutoff',
kkonganti@0 99 clivalue: (params.spades_cov_cutoff ?: '')
kkonganti@0 100 ],
kkonganti@0 101 'spades_k': [
kkonganti@0 102 clihelp: 'List of k-mer sizes (must be odd and less than 128). ' +
kkonganti@0 103 "Default: ${params.spades_k}",
kkonganti@0 104 cliflag: '-k',
kkonganti@0 105 clivalue: (params.spades_k ?: '')
kkonganti@0 106 ],
kkonganti@0 107 'spades_hmm': [
kkonganti@0 108 clihelp: 'Directory with custom hmms that replace the default ones (very rare). ' +
kkonganti@0 109 "Default: ${params.spades_hmm}",
kkonganti@0 110 cliflag: '--custom-hmms',
kkonganti@0 111 clivalue: (params.spades_hmm ?: '')
kkonganti@0 112 ]
kkonganti@0 113 ]
kkonganti@0 114
kkonganti@0 115 toolspecs.each {
kkonganti@0 116 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 117 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 118 }
kkonganti@0 119
kkonganti@0 120 return tool
kkonganti@0 121 }