annotate 0.7.0/lib/help/sourmashsigkmers.nf @ 21:4ce0e079377d tip

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