annotate 0.6.1/lib/help/spades.nf @ 14:b0a37e88ecb5

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