annotate samtools_rmdup.xml @ 2:3735f950b2f5 draft

Uploaded
author devteam
date Tue, 21 Apr 2015 17:21:53 -0400
parents fe83e6f8e65e
children bb40e4252392
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
1 <tool id="samtools_rmdup" name="RmDup" version="2.0">
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
2 <description>remove PCR duplicates</description>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
3 <macros>
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
4 <import>macros.xml</import>
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
5 </macros>
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
6 <expand macro="requirements"></expand>
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
7 <expand macro="stdio"></expand>
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
8 <expand macro="version_command"></expand>
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
9 <command>samtools rmdup
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
10 #if str( $bam_paired_end_type.bam_paired_end_type_selector ) == "PE"
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
11 ${bam_paired_end_type.force_se}
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
12 #else:
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
13 -s
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
14 #end if
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
15 "$input1" "$output1"
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
16 </command>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
17 <inputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
18 <param name="input1" type="data" format="bam" label="BAM File" />
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
19
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
20 <conditional name="bam_paired_end_type">
2
3735f950b2f5 Uploaded
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
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
22 <option value="PE" selected="True">BAM is paired-end</option>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
23 <option value="SE">BAM is single-end (-s)</option>
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
24 </param>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
25 <when value="PE">
2
3735f950b2f5 Uploaded
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
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
27 </when>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
28 <when value="SE" /> <!-- No extra parameters here -->
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
29 </conditional>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
30
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
31 </inputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
32 <outputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
33 <data name="output1" format="bam" />
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
34 </outputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
35 <tests>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
36 <test>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
37 <param name="input1" value="samtools-rmdup-input1.bam" ftype="bam" />
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
38 <param name="bam_paired_end_type_selector" value="PE" />
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
39 <param name="force_se" />
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
40 <output name="output1" file="samtools-rmdup-test1.bam" ftype="bam" sort="True" />
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
41 </test>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
42 </tests>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
43 <help>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
44
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
45 **What it does**
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
46
2
3735f950b2f5 Uploaded
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
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
48
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
49 -s rmdup for SE reads
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
50 -S treat PE reads as SE in rmdup (force -s)
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
51
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
52 </help>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
53 <expand macro="citations"></expand>
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
54 </tool>