|
kkonganti@1
|
1 // Help text for kraken2 within CPIPES.
|
|
kkonganti@1
|
2
|
|
kkonganti@1
|
3 def kraken2Help(params) {
|
|
kkonganti@1
|
4
|
|
kkonganti@1
|
5 Map tool = [:]
|
|
kkonganti@1
|
6 Map toolspecs = [:]
|
|
kkonganti@1
|
7 tool.text = [:]
|
|
kkonganti@1
|
8 tool.helpparams = [:]
|
|
kkonganti@1
|
9
|
|
kkonganti@1
|
10 toolspecs = [
|
|
kkonganti@1
|
11 'kraken2_db': [
|
|
kkonganti@1
|
12 clihelp: "Absolute path to kraken database. Default: ${params.kraken2_db}",
|
|
kkonganti@1
|
13 cliflag: '--db',
|
|
kkonganti@1
|
14 clivalue: null
|
|
kkonganti@1
|
15 ],
|
|
kkonganti@1
|
16 'kraken2_confidence': [
|
|
kkonganti@1
|
17 clihelp: 'Confidence score threshold which must be ' +
|
|
kkonganti@1
|
18 "between 0 and 1. Default: ${params.kraken2_confidence}",
|
|
kkonganti@1
|
19 cliflag: '--confidence',
|
|
kkonganti@1
|
20 clivalue: (params.kraken2_confidence ?: '')
|
|
kkonganti@1
|
21 ],
|
|
kkonganti@1
|
22 'kraken2_quick': [
|
|
kkonganti@1
|
23 clihelp: "Quick operation (use first hit or hits). Default: ${params.kraken2_quick}",
|
|
kkonganti@1
|
24 cliflag: '--quick',
|
|
kkonganti@1
|
25 clivalue: (params.kraken2_quick ? ' ' : '')
|
|
kkonganti@1
|
26 ],
|
|
kkonganti@1
|
27 'kraken2_use_mpa_style': [
|
|
kkonganti@1
|
28 clihelp: "Report output like Kraken 1's " +
|
|
kkonganti@1
|
29 "kraken-mpa-report. Default: ${params.kraken2_use_mpa_style}",
|
|
kkonganti@1
|
30 cliflag: '--use-mpa-style',
|
|
kkonganti@1
|
31 clivalue: (params.kraken2_use_mpa_style ? ' ' : '')
|
|
kkonganti@1
|
32 ],
|
|
kkonganti@1
|
33 'kraken2_minimum_base_quality': [
|
|
kkonganti@1
|
34 clihelp: 'Minimum base quality used in classification ' +
|
|
kkonganti@1
|
35 " which is only effective with FASTQ input. Default: ${params.kraken2_minimum_base_quality}",
|
|
kkonganti@1
|
36 cliflag: '--minimum-base-quality',
|
|
kkonganti@1
|
37 clivalue: (params.kraken2_minimum_base_quality ?: '')
|
|
kkonganti@1
|
38 ],
|
|
kkonganti@1
|
39 'kraken2_report_zero_counts': [
|
|
kkonganti@1
|
40 clihelp: 'Report counts for ALL taxa, even if counts are zero. ' +
|
|
kkonganti@1
|
41 "Default: ${params.kraken2_report_zero_counts}",
|
|
kkonganti@1
|
42 cliflag: '--report-zero-counts',
|
|
kkonganti@1
|
43 clivalue: (params.kraken2_report_zero_counts ? ' ' : '')
|
|
kkonganti@1
|
44 ],
|
|
kkonganti@1
|
45 'kraken2_report_minmizer_data': [
|
|
kkonganti@1
|
46 clihelp: 'Report minimizer and distinct minimizer count' +
|
|
kkonganti@1
|
47 ' information in addition to normal Kraken report. ' +
|
|
kkonganti@1
|
48 "Default: ${params.kraken2_report_minimizer_data}",
|
|
kkonganti@1
|
49 cliflag: '--report-minimizer-data',
|
|
kkonganti@1
|
50 clivalue: (params.kraken2_report_minimizer_data ? ' ' : '')
|
|
kkonganti@1
|
51 ],
|
|
kkonganti@1
|
52 'kraken2_use_names': [
|
|
kkonganti@1
|
53 clihelp: 'Print scientific names instead of just taxids. ' +
|
|
kkonganti@1
|
54 "Default: ${params.kraken2_use_names}",
|
|
kkonganti@1
|
55 cliflag: '--use-names',
|
|
kkonganti@1
|
56 clivalue: (params.kraken2_use_names ? ' ' : '')
|
|
kkonganti@1
|
57 ],
|
|
kkonganti@1
|
58 'kraken2_extract_bug': [
|
|
kkonganti@1
|
59 clihelp: 'Extract the reads or contigs beloging to this bug. ' +
|
|
kkonganti@1
|
60 "Default: ${params.kraken2_extract_bug}",
|
|
kkonganti@1
|
61 cliflag: null,
|
|
kkonganti@1
|
62 clivalue: null
|
|
kkonganti@1
|
63 ]
|
|
kkonganti@1
|
64 ]
|
|
kkonganti@1
|
65
|
|
kkonganti@1
|
66 toolspecs.each {
|
|
kkonganti@1
|
67 k, v -> tool.text['--' + k] = "${v.clihelp}"
|
|
kkonganti@1
|
68 tool.helpparams[k] = [ cliflag: "${v.cliflag}", clivalue: v.clivalue ]
|
|
kkonganti@1
|
69 }
|
|
kkonganti@1
|
70
|
|
kkonganti@1
|
71 return tool
|
|
kkonganti@1
|
72 } |
