annotate samtools_rmdup.xml @ 18:dc66a024be19 draft default tip

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