annotate 0.1.0/lib/help/pirate.nf @ 7:f02f143c02fb

"planemo upload"
author kkonganti
date Mon, 27 Nov 2023 20:24:38 -0500
parents c8597e9e1a97
children
rev   line source
kkonganti@0 1 // Help text for pirate within CPIPES.
kkonganti@0 2
kkonganti@0 3 def pirateHelp(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 'pirate_run': [
kkonganti@0 12 clihelp: 'Run pirate tool. Default: ' +
kkonganti@0 13 (params.pirate_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'pirate_steps': [
kkonganti@0 18 clihelp: '% identity thresholds to use for pangenome construction. ' +
kkonganti@0 19 "Default: ${params.pirate_steps}",
kkonganti@0 20 cliflag: '-s',
kkonganti@0 21 clivalue: (params.pirate_steps ?: '')
kkonganti@0 22 ],
kkonganti@0 23 'pirate_features': [
kkonganti@0 24 clihelp: 'Choose features to use for pangenome construction. ' +
kkonganti@0 25 'Multiple may be entered, seperated by a comma' +
kkonganti@0 26 "Default: ${params.pirate_features}",
kkonganti@0 27 cliflag: '-f',
kkonganti@0 28 clivalue: (params.pirate_features ?: '')
kkonganti@0 29 ],
kkonganti@0 30 'pirate_nucl': [
kkonganti@0 31 clihelp: 'CDS are not translated to AA sequence. ' +
kkonganti@0 32 "Default: ${params.pirate_nucl}",
kkonganti@0 33 cliflag: '-n',
kkonganti@0 34 clivalue: (params.pirate_nucl ? ' ' : '')
kkonganti@0 35 ],
kkonganti@0 36 'pirate_pan_opt': [
kkonganti@0 37 clihelp: 'Additional arguments to pass to pangenome_contruction. ' +
kkonganti@0 38 "Default: ${params.pirate_pan_opt}",
kkonganti@0 39 cliflag: '--pan-opt',
kkonganti@0 40 clivalue: (params.pirate_pan_opt ?: '')
kkonganti@0 41 ],
kkonganti@0 42 'pirate_pan_off': [
kkonganti@0 43 clihelp: "Don't run pangenome tool. " +
kkonganti@0 44 "Default: ${params.pirate_pan_off}",
kkonganti@0 45 cliflag: '--pan-off',
kkonganti@0 46 clivalue: (params.pirate_pan_off ? ' ' : '')
kkonganti@0 47 ],
kkonganti@0 48 'pirate_min_len': [
kkonganti@0 49 clihelp: 'Minimum length for feature extraction. ' +
kkonganti@0 50 "Default: ${params.pirate_min_len}",
kkonganti@0 51 cliflag: '--min-len',
kkonganti@0 52 clivalue: (params.pirate_min_len ?: '')
kkonganti@0 53 ],
kkonganti@0 54 'pirate_para_off': [
kkonganti@0 55 clihelp: 'Switch off paralog identification. ' +
kkonganti@0 56 "Default: ${params.pirate_para_off}",
kkonganti@0 57 cliflag: '--para-off',
kkonganti@0 58 clivalue: (params.pirate_para_off ?: '')
kkonganti@0 59 ],
kkonganti@0 60 'pirate_para_args': [
kkonganti@0 61 clihelp: 'Options to pass to paralog splitting algorithm. ' +
kkonganti@0 62 "Default: ${params.pirate_para_args}",
kkonganti@0 63 cliflag: '--para-args',
kkonganti@0 64 clivalue: (params.pirate_para_args ?: '')
kkonganti@0 65 ],
kkonganti@0 66 'pirate_classify_off': [
kkonganti@0 67 clihelp: 'Do not classify paralogs, assumes this has been ' +
kkonganti@0 68 'run previously. ' +
kkonganti@0 69 "Default: ${params.pirate_classify_off}",
kkonganti@0 70 cliflag: '--classify-off',
kkonganti@0 71 clivalue: (params.pirate_classify_off ? ' ' : '')
kkonganti@0 72 ],
kkonganti@0 73 'pirate_align': [
kkonganti@0 74 clihelp: 'align all genes and produce core/pangenome alignments. ' +
kkonganti@0 75 "Default: ${params.pirate_align}",
kkonganti@0 76 cliflag: '--align',
kkonganti@0 77 clivalue: (params.pirate_align ? ' ' : '')
kkonganti@0 78 ],
kkonganti@0 79 'pirate_rplots': [
kkonganti@0 80 clihelp: 'Plot summaries using R. ' +
kkonganti@0 81 "Default: ${params.pirate_rplots}",
kkonganti@0 82 cliflag: '--rplots',
kkonganti@0 83 clivalue: (params.pirate_rplots ? ' ' : '')
kkonganti@0 84 ]
kkonganti@0 85 ]
kkonganti@0 86
kkonganti@0 87 toolspecs.each {
kkonganti@0 88 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 89 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 90 }
kkonganti@0 91
kkonganti@0 92 return tool
kkonganti@0 93 }