annotate 0.5.0/lib/help/gsalkronapy.nf @ 0:3c767f9cfd88 draft default tip

planemo upload
author galaxytrakr
date Fri, 29 May 2026 13:37:56 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
1 // Help text for `gen_salmon_tph_and_krona_tsv.py` (gsalkronapy) within CPIPES.
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
2
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
3 def gsalkronapyHelp(params) {
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
4
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
5 Map tool = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
6 Map toolspecs = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
7 tool.text = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
8 tool.helpparams = [:]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
9
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
10 toolspecs = [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
11 'gsalkronapy_run': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run the `gen_salmon_tph_and_krona_tsv.py` script. Default: ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
13 (params.gsalkronapy_run ?: false),
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
16 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
17 'gsalkronapy_sf': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'Set the scaling factor by which TPM values ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
19 'are scaled down.' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
20 " Default: ${params.gsalkronapy_sf}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
21 cliflag: '-sf',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
22 clivalue: (params.gsalkronapy_sf ?: '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
23 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
24 'gsalkronapy_smres_suffix': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
25 clihelp: 'Find the `sourmash gather` result files ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
26 'ending in this suffix.' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
27 " Default: ${params.gsalkronapy_smres_suffix}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
28 cliflag: '-smres-suffix',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
29 clivalue: (params.gsalkronapy_smres_suffix ?: '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
30 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
31 'gsalkronapy_failed_suffix': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
32 clihelp: 'Find the sample names which failed classification stored ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
33 'inside the files ending in this suffix.' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
34 " Default: ${params.gsalkronapy_failed_suffix}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
35 cliflag: '-failed-suffix',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
36 clivalue: (params.gsalkronapy_failed_suffix ?: '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
37 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
38 'gsalkronapy_num_lin_cols': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
39 clihelp: 'Number of columns expected in the lineages CSV file. ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
40 " Default: ${params.gsalkronapy_num_lin_cols}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
41 cliflag: '-num-lin-cols',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
42 clivalue: (params.gsalkronapy_num_lin_cols ?: '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
43 ],
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
44 'gsalkronapy_lin_regex': [
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
45 clihelp: 'Number of columns expected in the lineages CSV file. ' +
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
46 " Default: ${params.gsalkronapy_num_lin_cols}",
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
47 cliflag: '-num-lin-cols',
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
48 clivalue: (params.gsalkronapy_num_lin_cols ?: '')
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
49 ]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
50 ]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
51
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
52 toolspecs.each {
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
53 k, v -> tool.text['--' + k] = "${v.clihelp}"
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
54 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
55 }
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
56
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
57 return tool
3c767f9cfd88 planemo upload
galaxytrakr
parents:
diff changeset
58 }