annotate 0.7.0/lib/help/sourmashsketch.nf @ 17:0e7a0053e4a6

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