annotate 0.1.0/lib/help/sourmashsigkmers.nf @ 2:408603fd75ca

"planemo upload"
author kkonganti
date Mon, 27 Nov 2023 14:21:42 -0500
parents c8597e9e1a97
children
rev   line source
kkonganti@0 1 // Help text for sourmash sigkmers within CPIPES.
kkonganti@0 2
kkonganti@0 3 def sourmashsigkmersHelp(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 'sourmashsigkmers_run': [
kkonganti@0 12 clihelp: 'Run `sourmash sigkmers` tool. Default: ' +
kkonganti@0 13 (params.sourmashsigkmers_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'sourmashsigkmers_k': [
kkonganti@0 18 clihelp: 'The k-mer size to select. ' +
kkonganti@0 19 "Default: ${params.sourmashsigkmers_k}",
kkonganti@0 20 cliflag: '-k',
kkonganti@0 21 clivalue: (params.sourmashsigkmers_k ?: '')
kkonganti@0 22 ],
kkonganti@0 23 'sourmashsigkmers_protein': [
kkonganti@0 24 clihelp: 'Choose a protein signature. ' +
kkonganti@0 25 "Default: ${params.sourmashsigkmers_protein}",
kkonganti@0 26 cliflag: '--protein',
kkonganti@0 27 clivalue: (params.sourmashsigkmers_protein ? ' ' : '')
kkonganti@0 28 ],
kkonganti@0 29 'sourmashsigkmers_noprotein': [
kkonganti@0 30 clihelp: 'Do not choose a protein signature. ' +
kkonganti@0 31 "Default: ${params.sourmashsigkmers_noprotein}",
kkonganti@0 32 cliflag: '--no-protein',
kkonganti@0 33 clivalue: (params.sourmashsigkmers_noprotein ? ' ' : '')
kkonganti@0 34 ],
kkonganti@0 35 'sourmashsigkmers_dayhoff': [
kkonganti@0 36 clihelp: 'Choose Dayhoff-encoded amino acid signatures. ' +
kkonganti@0 37 "Default: ${params.sourmashsigkmers_dayhoff}",
kkonganti@0 38 cliflag: '--dayhoff',
kkonganti@0 39 clivalue: (params.sourmashsigkmers_dayhoff ? ' ' : '')
kkonganti@0 40 ],
kkonganti@0 41 'sourmashsigkmers_nodayhoff': [
kkonganti@0 42 clihelp: 'Do not choose Dayhoff-encoded amino acid signatures. ' +
kkonganti@0 43 "Default: ${params.sourmashsigkmers_nodayhoff}",
kkonganti@0 44 cliflag: '--no-dayhoff',
kkonganti@0 45 clivalue: (params.sourmashsigkmers_nodayhoff ? ' ' : '')
kkonganti@0 46 ],
kkonganti@0 47 'sourmashsigkmers_hp': [
kkonganti@0 48 clihelp: 'Choose hydrophobic-polar-encoded amino acid signatures. ' +
kkonganti@0 49 "Default: ${params.sourmashsigkmers_hp}",
kkonganti@0 50 cliflag: '--hp',
kkonganti@0 51 clivalue: (params.sourmashsigkmers_hp ? ' ' : '')
kkonganti@0 52 ],
kkonganti@0 53 'sourmashsigkmers_nohp': [
kkonganti@0 54 clihelp: 'Do not choose hydrophobic-polar-encoded amino acid signatures. ' +
kkonganti@0 55 "Default: ${params.sourmashsigkmers_nohp}",
kkonganti@0 56 cliflag: '--no-hp',
kkonganti@0 57 clivalue: (params.sourmashsigkmers_nohp ? ' ' : '')
kkonganti@0 58 ],
kkonganti@0 59 'sourmashsigkmers_dna': [
kkonganti@0 60 clihelp: 'Choose DNA signature. ' +
kkonganti@0 61 "Default: ${params.sourmashsigkmers_dna}",
kkonganti@0 62 cliflag: '--dna',
kkonganti@0 63 clivalue: (params.sourmashsigkmers_dna ? ' ' : '')
kkonganti@0 64 ],
kkonganti@0 65 'sourmashsigkmers_nodna': [
kkonganti@0 66 clihelp: 'Do not choose DNA signature. ' +
kkonganti@0 67 "Default: ${params.sourmashsigkmers_nodna}",
kkonganti@0 68 cliflag: '--no-dna',
kkonganti@0 69 clivalue: (params.sourmashsigkmers_nodna ? ' ' : '')
kkonganti@0 70 ],
kkonganti@0 71 'sourmashsigkmers_save_kmers': [
kkonganti@0 72 clihelp: 'Save k-mers and hash values to a CSV file. ' +
kkonganti@0 73 "Default: ${params.sourmashsigkmers_save_kmers}",
kkonganti@0 74 cliflag: null,
kkonganti@0 75 clivalue: null
kkonganti@0 76 ],
kkonganti@0 77 'sourmashsigkmers_save_seqs': [
kkonganti@0 78 clihelp: 'Save sequences with matching hash values to a FASTA file. ' +
kkonganti@0 79 "Default: ${params.sourmashsigkmers_save_seqs}",
kkonganti@0 80 cliflag: null,
kkonganti@0 81 clivalue: null
kkonganti@0 82 ],
kkonganti@0 83 'sourmashsigkmers_translate': [
kkonganti@0 84 clihelp: 'Translate DNA k-mers into amino acids (for protein, dayhoff, and hp sketches). ' +
kkonganti@0 85 "Default: ${params.sourmashsigkmers_translate}",
kkonganti@0 86 cliflag: '--translate',
kkonganti@0 87 clivalue: (params.sourmashsigkmers_translate ? ' ' : '')
kkonganti@0 88 ]
kkonganti@0 89 ]
kkonganti@0 90
kkonganti@0 91 toolspecs.each {
kkonganti@0 92 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 93 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 94 }
kkonganti@0 95
kkonganti@0 96 return tool
kkonganti@0 97 }