annotate samtools_rmdup.xml @ 2:b1b367792034 draft

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:55:32 -0400
parents 75e4b89f1004
children d67b176f2dae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
1 <tool id="samtools_rmdup" name="RmDup" version="2.0">
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
2 <description>remove PCR duplicates</description>
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
3 <macros>
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
4 <import>macros.xml</import>
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
5 </macros>
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
6 <expand macro="requirements"></expand>
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
7 <expand macro="stdio"></expand>
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
8 <expand macro="version_command"></expand>
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
9 <command>samtools rmdup
27136ac45e90 Uploaded
devteam
parents:
diff changeset
10 #if str( $bam_paired_end_type.bam_paired_end_type_selector ) == "PE"
27136ac45e90 Uploaded
devteam
parents:
diff changeset
11 ${bam_paired_end_type.force_se}
27136ac45e90 Uploaded
devteam
parents:
diff changeset
12 #else:
27136ac45e90 Uploaded
devteam
parents:
diff changeset
13 -s
27136ac45e90 Uploaded
devteam
parents:
diff changeset
14 #end if
27136ac45e90 Uploaded
devteam
parents:
diff changeset
15 "$input1" "$output1"
27136ac45e90 Uploaded
devteam
parents:
diff changeset
16 </command>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
17 <inputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
18 <param name="input1" type="data" format="bam" label="BAM File" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
19
27136ac45e90 Uploaded
devteam
parents:
diff changeset
20 <conditional name="bam_paired_end_type">
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
21 <param name="bam_paired_end_type_selector" type="select" label="Is this paired-end or single end data">
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
22 <option value="PE" selected="True">BAM is paired-end</option>
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
23 <option value="SE">BAM is single-end (-s)</option>
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
24 </param>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
25 <when value="PE">
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
26 <param name="force_se" type="boolean" label="Treat as single-end" help="-S" truevalue="-S" falsevalue="" checked="False"/>
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
27 </when>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
28 <when value="SE" /> <!-- No extra parameters here -->
27136ac45e90 Uploaded
devteam
parents:
diff changeset
29 </conditional>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
30
27136ac45e90 Uploaded
devteam
parents:
diff changeset
31 </inputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
32 <outputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
33 <data name="output1" format="bam" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
34 </outputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
35 <tests>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
36 <test>
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
37 <param name="input1" value="samtools-rmdup-input1.bam" ftype="bam" />
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
38 <param name="bam_paired_end_type_selector" value="PE" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
39 <param name="force_se" />
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
40 <output name="output1" file="samtools-rmdup-test1.bam" ftype="bam" sort="True" />
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
41 </test>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
42 </tests>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
43 <help>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
44
27136ac45e90 Uploaded
devteam
parents:
diff changeset
45 **What it does**
27136ac45e90 Uploaded
devteam
parents:
diff changeset
46
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
47 Remove potential PCR duplicates: if multiple read pairs have identical external coordinates, only retain the pair with highest mapping quality. In the paired-end mode, this command ONLY works with FR orientation and requires ISIZE is correctly set. It does not work for unpaired reads (e.g. two ends mapped to different chromosomes or orphan reads). This tool has the following parameters::
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
48
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
49 -s rmdup for SE reads
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
50 -S treat PE reads as SE in rmdup (force -s)
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
51
27136ac45e90 Uploaded
devteam
parents:
diff changeset
52 </help>
2
b1b367792034 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
53 <expand macro="citations"></expand>
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
54 </tool>