annotate 0.5.0/lib/help/gsalkronapy.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 `gen_salmon_tph_and_krona_tsv.py` (gsalkronapy) within CPIPES.
kkonganti@0 2
kkonganti@0 3 def gsalkronapyHelp(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 'gsalkronapy_run': [
kkonganti@0 12 clihelp: 'Run the `gen_salmon_tph_and_krona_tsv.py` script. Default: ' +
kkonganti@0 13 (params.gsalkronapy_run ?: false),
kkonganti@0 14 cliflag: null,
kkonganti@0 15 clivalue: null
kkonganti@0 16 ],
kkonganti@0 17 'gsalkronapy_sf': [
kkonganti@0 18 clihelp: 'Set the scaling factor by which TPM values ' +
kkonganti@0 19 'are scaled down.' +
kkonganti@0 20 " Default: ${params.gsalkronapy_sf}",
kkonganti@0 21 cliflag: '-sf',
kkonganti@0 22 clivalue: (params.gsalkronapy_sf ?: '')
kkonganti@0 23 ],
kkonganti@0 24 'gsalkronapy_smres_suffix': [
kkonganti@0 25 clihelp: 'Find the `sourmash gather` result files ' +
kkonganti@0 26 'ending in this suffix.' +
kkonganti@0 27 " Default: ${params.gsalkronapy_smres_suffix}",
kkonganti@0 28 cliflag: '-smres-suffix',
kkonganti@0 29 clivalue: (params.gsalkronapy_smres_suffix ?: '')
kkonganti@0 30 ],
kkonganti@0 31 'gsalkronapy_failed_suffix': [
kkonganti@0 32 clihelp: 'Find the sample names which failed classification stored ' +
kkonganti@0 33 'inside the files ending in this suffix.' +
kkonganti@0 34 " Default: ${params.gsalkronapy_failed_suffix}",
kkonganti@0 35 cliflag: '-failed-suffix',
kkonganti@0 36 clivalue: (params.gsalkronapy_failed_suffix ?: '')
kkonganti@0 37 ],
kkonganti@0 38 'gsalkronapy_num_lin_cols': [
kkonganti@0 39 clihelp: 'Number of columns expected in the lineages CSV file. ' +
kkonganti@0 40 " Default: ${params.gsalkronapy_num_lin_cols}",
kkonganti@0 41 cliflag: '-num-lin-cols',
kkonganti@0 42 clivalue: (params.gsalkronapy_num_lin_cols ?: '')
kkonganti@0 43 ],
kkonganti@0 44 'gsalkronapy_lin_regex': [
kkonganti@0 45 clihelp: 'Number of columns expected in the lineages CSV file. ' +
kkonganti@0 46 " Default: ${params.gsalkronapy_num_lin_cols}",
kkonganti@0 47 cliflag: '-num-lin-cols',
kkonganti@0 48 clivalue: (params.gsalkronapy_num_lin_cols ?: '')
kkonganti@0 49 ]
kkonganti@0 50 ]
kkonganti@0 51
kkonganti@0 52 toolspecs.each {
kkonganti@0 53 k, v -> tool.text['--' + k] = "${v.clihelp}"
kkonganti@0 54 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
kkonganti@0 55 }
kkonganti@0 56
kkonganti@0 57 return tool
kkonganti@0 58 }