comparison lofreq_alnqual.xml @ 0:606542a18f82 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
author iuc
date Tue, 17 Dec 2019 17:26:09 -0500
parents
children e0e2fd665102
comparison
equal deleted inserted replaced
-1:000000000000 0:606542a18f82
1 <tool id="lofreq_alnqual" name="Add LoFreq alignment quality scores" version="@WRAPPER_VERSION@0">
2 <description>to aligned read SAM/BAM records</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <expand macro="requirements" />
7 <command detect_errors="exit_code"><![CDATA[
8 @PREPARE_REF@
9 lofreq alnqual -b ${alnqual_choice.extended_baq} ${alnqual_choice.alnquals_to_use} $recompute_all '$reads' '$reference_fasta_fn' > '$output'
10 ]]></command>
11 <inputs>
12 <param type="data" name="reads" format="bam" label="Reads" />
13 <expand macro="reference_interface" />
14 <expand macro="handle_alnqual" mode="Add" />
15 <param argument="-r" name="recompute_all" type="boolean" truevalue="-r" falsevalue=""
16 label="Overwrite exisitng values with newly computed ones" />
17 </inputs>
18 <outputs>
19 <data name="output" format="bam" label="${tool.name} to ${on_string}" />
20 </outputs>
21 <tests>
22 <test>
23 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
24 <param name="ref_selector" value="history" />
25 <param name="ref" ftype="fasta" value="pBR322.fa" />
26 <output name="output" file="alnqual-out1.bam" />
27 </test>
28 <test>
29 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
30 <param name="ref_selector" value="history" />
31 <param name="ref" ftype="fasta" value="pBR322.fa" />
32 <conditional name="alnqual_choice">
33 <param name="alnquals_to_use" value="-B" />
34 </conditional>
35 <output name="output" file="alnqual-out2.bam" />
36 </test>
37 <test>
38 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
39 <param name="ref_selector" value="history" />
40 <param name="ref" ftype="fasta" value="pBR322.fa" />
41 <conditional name="alnqual_choice">
42 <param name="alnquals_to_use" value="-A" />
43 </conditional>
44 <output name="output" file="alnqual-out3.bam" />
45 </test>
46 <test>
47 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
48 <param name="ref_selector" value="history" />
49 <param name="ref" ftype="fasta" value="pBR322.fa" />
50 <conditional name="alnqual_choice">
51 <param name="extended_baq" value="false" />
52 </conditional>
53 <output name="output" file="alnqual-out4.bam" />
54 </test>
55 <test>
56 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
57 <param name="ref_selector" value="history" />
58 <param name="ref" ftype="fasta" value="pBR322.fa" />
59 <param name="recompute" value="true" />
60 <output name="output" file="alnqual-out5.bam" />
61 </test>
62 </tests>
63 <help><![CDATA[
64 lofreq alnqual: add base- and indel-alignment qualities (BAQ, IDAQ) to
65 aligned read records
66
67 .. class:: infomark
68
69 **What it does**
70
71 This tool can compute base- and/or indel-alignment quality scores for aligned
72 reads in SAM/BAM format and store these scores under the custom tags ``lb``
73 (for the base alignment qualities, ``ai`` (insertion alignment qualities) and
74 ``ad`` (deletion alignment qualities), which it will add to its output BAM.
75
76 These tags and their scores can be reused by LoFreq call, which can
77 incorporate them into its model for variant quality calculation.
78
79 .. class:: warning
80
81 **Do not realign** your reads after adding alignment qualities to them since
82 the scores would not be updated in the process!
83
84 Notes:
85
86 - While LoFreq call can optionally calculate the exact same scores on the fly
87 if needed, having the scores added to the aligned read records is going to
88 save computation time with repeated variant calling from the same input data.
89
90 - The base alignment quality scores have the same meaning as in samtools, but
91 are expressed as absolute scores, not as base quality offsets like with the
92 `BQ` tag generated by samtools.
93
94 - `ai` and `ad` tags, if requested, will only be added to reads containing
95 insertions/deletions.
96 ]]></help>
97 <expand macro="citations" />
98 </tool>