annotate 0.3.0/lib/help/spades.nf @ 92:295c2597a475

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