annotate lofreq_alnqual.xml @ 0:d1b53ef02092 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
author dave
date Wed, 27 Nov 2019 15:24:44 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
1 <tool id="lofreq_alnqual" name="Add BAQ and IDAQ" version="@WRAPPER_VERSION@0">
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
2 <description>to BAM with LoFreq</description>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
3 <macros>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
4 <import>macros.xml</import>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
5 </macros>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
6 <expand macro="requirements" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
8 @PREPARE_REF@
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
9 lofreq alnqual -b $extended $no_baq $no_idaq $recompute_all '$reads' '$reference_fasta_fn' > '$output'
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
10 ]]></command>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
11 <inputs>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
12 <param type="data" name="reads" format="bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
13 <expand macro="reference_interface" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
14 <param name="extended" argument="-e" type="boolean" truevalue="-e" falsevalue="" label="Use default instead of extended BAQ" help="Extended BAQ gives better sensitivity with lower specificity" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
15 <param name="no_baq" argument="-B" type="boolean" truevalue="-B" falsevalue="" label="Skip base alignment quality calculation" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
16 <param name="no_idaq" argument="-A" type="boolean" truevalue="-A" falsevalue="" label="Skip indel alignment quality calculation" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
17 <param name="recompute_all" argument="-r" type="boolean" truevalue="-r" falsevalue="" label="Overwrite existing values with computed values" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
18 </inputs>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
19 <outputs>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
20 <data name="output" format="bam" label="${tool.name} to ${on_string}" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
21 </outputs>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
22 <tests>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
23 <test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
24 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
25 <param name="ref_selector" value="history" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
26 <param name="ref" ftype="fasta" value="pBR322.fa" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
27 <output name="output" file="alnqual-out1.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
28 </test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
29 <test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
30 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
31 <param name="ref_selector" value="history" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
32 <param name="ref" ftype="fasta" value="pBR322.fa" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
33 <param name="no_baq" value="true" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
34 <output name="output" file="alnqual-out2.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
35 </test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
36 <test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
37 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
38 <param name="ref_selector" value="history" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
39 <param name="ref" ftype="fasta" value="pBR322.fa" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
40 <param name="no_idaq" value="true" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
41 <output name="output" file="alnqual-out3.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
42 </test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
43 <test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
44 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
45 <param name="ref_selector" value="history" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
46 <param name="ref" ftype="fasta" value="pBR322.fa" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
47 <param name="extended" value="true" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
48 <output name="output" file="alnqual-out4.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
49 </test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
50 <test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
51 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
52 <param name="ref_selector" value="history" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
53 <param name="ref" ftype="fasta" value="pBR322.fa" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
54 <param name="recompute" value="true" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
55 <output name="output" file="alnqual-out5.bam" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
56 </test>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
57 </tests>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
58 <help><![CDATA[
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
59 lofreq alnqual: add base- and indel-alignment qualities (BAQ, IDAQ) to BAM file
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
60
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
61 Usage: lofreq alnqual [options] <aln.bam> <ref.fasta>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
62 Options:
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
63 -b BAM output (instead of SAM)
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
64 -u Uncompressed BAM output (for piping)
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
65 -S The input is SAM with header
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
66 -e Use default instead of extended BAQ (the latter gives better sensitivity but lower specificity)
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
67 -B Don't compute base alignment qualities
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
68 -A Don't compute indel alignment qualities
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
69 -r Recompute i.e. overwrite existing values
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
70 - Output BAM will be written to stdout.
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
71 - Only reads containing indels will contain indel-alignment qualities (tags: ai and ad).
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
72 - Do not change the alignmnent after running this, i.e. use this as last postprocessing step!
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
73 - This program is based on samtools. BAQ was introduced by Heng Li PMID:21320865
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
74
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
75
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
76 ]]></help>
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
77 <expand macro="citations" />
d1b53ef02092 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit b8b08e76ebdca1fceef0da1b377eb4b6d45b0847-dirty"
dave
parents:
diff changeset
78 </tool>