annotate 0.2.0/lib/help/pirate.nf @ 11:a5f31c44f8c9

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