annotate 0.5.0/lib/help/sourmashsketch.nf @ 0:97cd2f532efe

planemo upload
author kkonganti
date Mon, 31 Mar 2025 14:50:40 -0400
parents
children
rev   line source
kkonganti@0 1 // Help text for sourmash sketch dna within CPIPES.
kkonganti@0 2
kkonganti@0 3 def sourmashsketchHelp(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 'sourmashsketch_run': [
kkonganti@0 12 clihelp: 'Run `sourmash sketch dna` tool. Default: ' +
kkonganti@0 13 (params.sourmashsketch_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'sourmashsketch_mode': [
kkonganti@0 18 clihelp: "Select which type of signatures to be created: dna, protein, fromfile or translate. "
kkonganti@0 19 + "Default: ${params.sourmashsketch_mode}",
kkonganti@0 20 cliflag: "${params.sourmashsketch_mode}",
kkonganti@0 21 clivalue: ' '
kkonganti@0 22 ],
kkonganti@0 23 'sourmashsketch_p': [
kkonganti@0 24 clihelp: 'Signature parameters to use. ' +
kkonganti@0 25 "Default: ${params.sourmashsketch_p}",
kkonganti@0 26 cliflag: '-p',
kkonganti@0 27 clivalue: (params.sourmashsketch_p ?: '')
kkonganti@0 28 ],
kkonganti@0 29 'sourmashsketch_file': [
kkonganti@0 30 clihelp: '<path> A text file containing a list of sequence files to load. ' +
kkonganti@0 31 "Default: ${params.sourmashsketch_file}",
kkonganti@0 32 cliflag: '--from-file',
kkonganti@0 33 clivalue: (params.sourmashsketch_file ?: '')
kkonganti@0 34 ],
kkonganti@0 35 'sourmashsketch_f': [
kkonganti@0 36 clihelp: 'Recompute signatures even if the file exists. ' +
kkonganti@0 37 "Default: ${params.sourmashsketch_f}",
kkonganti@0 38 cliflag: '-f',
kkonganti@0 39 clivalue: (params.sourmashsketch_f ? ' ' : '')
kkonganti@0 40 ],
kkonganti@0 41 'sourmashsketch_name': [
kkonganti@0 42 clihelp: 'Name the signature generated from each file after the first record in the file. ' +
kkonganti@0 43 "Default: ${params.sourmashsketch_name}",
kkonganti@0 44 cliflag: '--name-from-first',
kkonganti@0 45 clivalue: (params.sourmashsketch_name ? ' ' : '')
kkonganti@0 46 ],
kkonganti@0 47 'sourmashsketch_randomize': [
kkonganti@0 48 clihelp: 'Shuffle the list of input files randomly. ' +
kkonganti@0 49 "Default: ${params.sourmashsketch_randomize}",
kkonganti@0 50 cliflag: '--randomize',
kkonganti@0 51 clivalue: (params.sourmashsketch_randomize ? ' ' : '')
kkonganti@0 52 ]
kkonganti@0 53 ]
kkonganti@0 54
kkonganti@0 55 toolspecs.each {
kkonganti@0 56 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 57 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 58 }
kkonganti@0 59
kkonganti@0 60 return tool
kkonganti@0 61 }