annotate 1.0.0/lib/help/medakaconsensus.nf @ 0:0a8dda29956e draft default tip

planemo upload
author galaxytrakr
date Thu, 28 May 2026 20:41:10 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
1 // Help text for medaka `consensus` within CPIPES.
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
2
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
3 def medakaconsensusHelp(params) {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
4
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
5 Map tool = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
6 Map toolspecs = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
7 tool.text = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
8 tool.helpparams = [:]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
9
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
10 toolspecs = [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
11 'medakaconsensus_run': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
12 clihelp: 'Run medaka `consensus` tool. Default: ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
13 (params.medakaconsensus_run ?: false),
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
14 cliflag: null,
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
15 clivalue: null
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
16 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
17 'medakaconsensus_batch_size': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
18 clihelp: 'Inference batch size. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
19 "Default: ${params.medakaconsensus_batch_size}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
20 cliflag: '--batch_size',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
21 clivalue: (params.medakaconsensus_batch_size ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
22 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
23 'medakaconsensus_chunk_len': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
24 clihelp: 'Chunk length of samples. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
25 "Default: ${params.medakaconsensus_chunk_len}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
26 cliflag: '--chunk_len',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
27 clivalue: (params.medakaconsensus_chunk_len ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
28 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
29 'medakaconsensus_chunk_ovlp': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
30 clihelp: 'Overlap of chunks. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
31 "Default: ${params.medakaconsensus_chunk_ovlp}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
32 cliflag: '--chunk_ovlp',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
33 clivalue: (params.medakaconsensus_chunk_ovlp ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
34 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
35 'medakaconsensus_regions': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
36 clihelp: 'Genomic regions to analyze, or a bed file. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
37 "Default: ${params.medakaconsensus_regions}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
38 cliflag: '--regions',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
39 clivalue: (params.medakaconsensus_regions ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
40 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
41 'medakaconsensus_model': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
42 clihelp: 'Model to use. Can be a medaka model name or a basecaller model name ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
43 "suffixed with ':consensus' or ':variant'. " +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
44 "Ex: 'dna_r10.4.1_e8.2_400bps_hac@v4.1.0:variant'. " +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
45 "Default: ${params.medakaconsensus_model}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
46 cliflag: '--model',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
47 clivalue: (params.medakaconsensus_model ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
48 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
49 'medakaconsensus_auto_model': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
50 clihelp: 'Automatically choose model according to input. Use one of ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
51 "'consensus' or 'variant'. Default: ${params.medakaconsensus_auto_model}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
52 cliflag: '--auto_model',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
53 clivalue: (params.medakaconsensus_auto_model ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
54 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
55 'medakaconsensus_bam_chunk': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
56 clihelp: 'Size of reference chunks each worker parses from bam. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
57 "Default: ${params.medakaconsensus_bam_chunk}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
58 cliflag: '--bam_chunk',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
59 clivalue: (params.medakaconsensus_bam_chunk ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
60 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
61 'medakaconsensus_chk_out': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
62 clihelp: 'Verify integrity of output file after inference. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
63 "Default: ${params.medakaconsensus_chk_out}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
64 cliflag: '--check_output',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
65 clivalue: (params.medakaconsensus_chk_out ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
66 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
67 'medakaconsensus_save_feats': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
68 clihelp: 'Save features with consensus probabilities. ' +
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
69 "Default: ${params.medakaconsensus_save_feats}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
70 cliflag: '--save_features',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
71 clivalue: (params.medakaconsensus_save_feats ? ' ' : '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
72 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
73 'medakaconsensus_read_grp': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
74 clihelp: "Read group to select. Default: ${params.medakaconsensus_read_grp}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
75 cliflag: '--RG',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
76 clivalue: (params.medakaconsensus_read_grp ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
77 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
78 'medakaconsensus_tag_name': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
79 clihelp: "Two-letter tag name. Default: ${params.medakaconsensus_tag_name}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
80 cliflag: '--tag_name',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
81 clivalue: (params.medakaconsensus_tag_name ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
82 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
83 'medakaconsensus_tag_val': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
84 clihelp: "Value of tag. Default: ${params.medakaconsensus_tag_val}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
85 cliflag: '--tag_val',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
86 clivalue: (params.medakaconsensus_tag_val ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
87 ],
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
88 'medakaconsensus_tag_keep': [
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
89 clihelp: 'Keep alignments when tag is missing. '
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
90 + "Default: ${params.medakaconsensus_tag_keep}",
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
91 cliflag: '--tag_keep_missing',
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
92 clivalue: (params.medakaconsensus_tag_keep ?: '')
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
93 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
94 ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
95
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
96 toolspecs.each {
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
97 k, v -> tool.text['--' + k] = "${v.clihelp}"
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
98 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
99 }
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
100
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
101 return tool
0a8dda29956e planemo upload
galaxytrakr
parents:
diff changeset
102 }