annotate 0.6.1/lib/help/sourmashsigkmers.nf @ 11:749faef1caa9

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