annotate 0.5.0/lib/help/sourmashsketch.nf @ 1:365849f031fd

"planemo upload"
author kkonganti
date Mon, 05 Jun 2023 18:48:51 -0400
parents
children
rev   line source
kkonganti@1 1 // Help text for sourmash sketch dna within CPIPES.
kkonganti@1 2
kkonganti@1 3 def sourmashsketchHelp(params) {
kkonganti@1 4
kkonganti@1 5 Map tool = [:]
kkonganti@1 6 Map toolspecs = [:]
kkonganti@1 7 tool.text = [:]
kkonganti@1 8 tool.helpparams = [:]
kkonganti@1 9
kkonganti@1 10 toolspecs = [
kkonganti@1 11 'sourmashsketch_run': [
kkonganti@1 12 clihelp: 'Run `sourmash sketch dna` tool. Default: ' +
kkonganti@1 13 (params.sourmashsketch_run ?: false),
kkonganti@1 14 cliflag: null,
kkonganti@1 15 clivalue: null
kkonganti@1 16 ],
kkonganti@1 17 'sourmashsketch_mode': [
kkonganti@1 18 clihelp: "Select which type of signatures to be created: dna, protein, fromfile or translate. "
kkonganti@1 19 + "Default: ${params.sourmashsketch_mode}",
kkonganti@1 20 cliflag: "${params.sourmashsketch_mode}",
kkonganti@1 21 clivalue: ' '
kkonganti@1 22 ],
kkonganti@1 23 'sourmashsketch_p': [
kkonganti@1 24 clihelp: 'Signature parameters to use. ' +
kkonganti@1 25 "Default: ${params.sourmashsketch_p}",
kkonganti@1 26 cliflag: '-p',
kkonganti@1 27 clivalue: (params.sourmashsketch_p ?: '')
kkonganti@1 28 ],
kkonganti@1 29 'sourmashsketch_file': [
kkonganti@1 30 clihelp: '<path> A text file containing a list of sequence files to load. ' +
kkonganti@1 31 "Default: ${params.sourmashsketch_file}",
kkonganti@1 32 cliflag: '--from-file',
kkonganti@1 33 clivalue: (params.sourmashsketch_file ?: '')
kkonganti@1 34 ],
kkonganti@1 35 'sourmashsketch_f': [
kkonganti@1 36 clihelp: 'Recompute signatures even if the file exists. ' +
kkonganti@1 37 "Default: ${params.sourmashsketch_f}",
kkonganti@1 38 cliflag: '-f',
kkonganti@1 39 clivalue: (params.sourmashsketch_f ? ' ' : '')
kkonganti@1 40 ],
kkonganti@1 41 'sourmashsketch_merge': [
kkonganti@1 42 clihelp: 'Merge all input files into one signature file with the specified name. ' +
kkonganti@1 43 "Default: ${params.sourmashsketch_merge}",
kkonganti@1 44 cliflag: '--merge',
kkonganti@1 45 clivalue: (params.sourmashsketch_merge ? ' ' : '')
kkonganti@1 46 ],
kkonganti@1 47 'sourmashsketch_singleton': [
kkonganti@1 48 clihelp: 'Compute a signature for each sequence record individually. ' +
kkonganti@1 49 "Default: ${params.sourmashsketch_singleton}",
kkonganti@1 50 cliflag: '--singleton',
kkonganti@1 51 clivalue: (params.sourmashsketch_singleton ? ' ' : '')
kkonganti@1 52 ],
kkonganti@1 53 'sourmashsketch_name': [
kkonganti@1 54 clihelp: 'Name the signature generated from each file after the first record in the file. ' +
kkonganti@1 55 "Default: ${params.sourmashsketch_name}",
kkonganti@1 56 cliflag: '--name-from-first',
kkonganti@1 57 clivalue: (params.sourmashsketch_name ? ' ' : '')
kkonganti@1 58 ],
kkonganti@1 59 'sourmashsketch_randomize': [
kkonganti@1 60 clihelp: 'Shuffle the list of input files randomly. ' +
kkonganti@1 61 "Default: ${params.sourmashsketch_randomize}",
kkonganti@1 62 cliflag: '--randomize',
kkonganti@1 63 clivalue: (params.sourmashsketch_randomize ? ' ' : '')
kkonganti@1 64 ]
kkonganti@1 65 ]
kkonganti@1 66
kkonganti@1 67 toolspecs.each {
kkonganti@1 68 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@1 69 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@1 70 }
kkonganti@1 71
kkonganti@1 72 return tool
kkonganti@1 73 }