annotate lofreq_viterbi.xml @ 1:ecd80c7c3886 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
author iuc
date Fri, 31 Jan 2020 06:17:30 -0500
parents 33a416e1659e
children af7e416d8176
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
1 <tool id="lofreq_viterbi" name="Realign reads" version="@TOOL_VERSION@+galaxy1">
0
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
2 <description>with LoFreq viterbi</description>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
3 <macros>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
5 </macros>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
6 <expand macro="requirements">
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
7 <requirement type="package" version="1.9">samtools</requirement>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
8 </expand>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
10 @PREPARE_REF@
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
11 lofreq viterbi
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
12 --ref '$reference_fasta_fn'
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
13 ${adv_options.delflags}
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
14 --defqual ${adv_options.bq2_handling.defqual}
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
15 --out tmp.bam '$reads' &&
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
16
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
17 samtools sort -T "\${TMPDIR:-.}" -@ \${GALAXY_SLOTS:-1} -O BAM -o '$realigned' tmp.bam
0
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
18 ]]></command>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
19 <inputs>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
20 <param name="reads" type="data" format="bam" label="Reads to realign" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
21 <expand macro="reference_interface" />
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
22 <section name="adv_options" title="Advanced options" expanded="false">
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
23 <param argument="--keepflags" name="delflags" type="boolean" truevalue="" falsevalue="--keepflags" checked="true"
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
24 label="Delete flags MC, MD, NM, and A?"
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
25 help="These flags are all prone to getting invalidated during realignment. Keep them only if you know what you are doing." />
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
26 <conditional name="bq2_handling">
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
27 <param name="replace_bq2" type="select"
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
28 label="How to handle base qualities of 2?"
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
29 help="In sequenced reads obtained with Illumina sequencing pipelines before version 1.8, base quality 2 is special in that it serves as a general indicator of low quality of the corresponding bases. For such reads, the tool can make an optimistic guess of the real quality of such bases by replacing base qualities of 2 with the median of all other base qualities observed in the read. Alternatively, you can provide a fixed replacement value. For recently obtained sequencing data, just keep BQ2 values unchanged (the default) since they have no special meaning.">
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
30 <option value="keep">Keep unchanged</option>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
31 <option value="dynamic">Adjust dynamically</option>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
32 <option value="fixed">Replace with fixed base quality</option>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
33 </param>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
34 <when value="keep">
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
35 <param name="defqual" type="hidden" value="2" />
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
36 </when>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
37 <when value="dynamic">
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
38 <param name="defqual" type="hidden" value="-1" />
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
39 </when>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
40 <when value="fixed">
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
41 <param argument="--defqual" name="defqual" type="integer" value="2" min="0"
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
42 label="Quality to assume for all bases with BQ2" />
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
43 </when>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
44 </conditional>
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
45 </section>
0
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
46 </inputs>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
47 <outputs>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
48 <data name="realigned" format="bam" label="${tool.name} on ${on_string}: Realigned reads" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
49 </outputs>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
50 <tests>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
51 <test>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
52 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
53 <param name="ref_selector" value="history" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
54 <param name="ref" ftype="fasta" value="pBR322.fa" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
55 <output name="realigned" file="viterbi-out1.bam" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
56 </test>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
57 <test>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
58 <param name="reads" ftype="bam" value="lofreq-in1.bam" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
59 <param name="ref_selector" value="history" />
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
60 <section name="adv_options">
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
61 <param name="delflags" value="false" />
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
62 </section>
0
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
63 <param name="ref" ftype="fasta" value="pBR322.fa" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
64 <output name="realigned" file="viterbi-out2.bam" />
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
65 </test>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
66 </tests>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
67 <help><![CDATA[
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
68 lofreq viterbi: Probabilistic realignment of mapped reads to correct mapping errors.
0
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
69
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
70 .. class:: Warning mark
0
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
71
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
72 Not recommended for non-Illumina data.
0
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
73
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
74 ]]></help>
33a416e1659e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9efcb813ab17041c7f5aad834dfff45bd7046c60"
iuc
parents:
diff changeset
75 <expand macro="citations" />
1
ecd80c7c3886 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/lofreq commit 9e41ac63171c3e3a6fd2b4d018d0c60c9f1fbae1"
iuc
parents: 0
diff changeset
76 </tool>