annotate samtools_rmdup.xml @ 3:bb40e4252392 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_rmdup commit b9c475e401d953823899cb67833ebef2a566b427
author devteam
date Tue, 01 Dec 2015 16:12:16 -0500
parents 3735f950b2f5
children 9129584416e2
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>
3
bb40e4252392 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_rmdup commit b9c475e401d953823899cb67833ebef2a566b427
devteam
parents: 2
diff changeset
6 <requirements>
bb40e4252392 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_rmdup commit b9c475e401d953823899cb67833ebef2a566b427
devteam
parents: 2
diff changeset
7 <requirement type="package" version="0.1.19">samtools</requirement>
bb40e4252392 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_rmdup commit b9c475e401d953823899cb67833ebef2a566b427
devteam
parents: 2
diff changeset
8 </requirements>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
9 <expand macro="stdio"></expand>
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
10 <expand macro="version_command"></expand>
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
11 <command>samtools rmdup
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
12 #if str( $bam_paired_end_type.bam_paired_end_type_selector ) == "PE"
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
13 ${bam_paired_end_type.force_se}
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
14 #else:
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
15 -s
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
16 #end if
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
17 "$input1" "$output1"
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
18 </command>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
19 <inputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
20 <param name="input1" type="data" format="bam" label="BAM File" />
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
21
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
22 <conditional name="bam_paired_end_type">
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
23 <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
24 <option value="PE" selected="True">BAM is paired-end</option>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
25 <option value="SE">BAM is single-end (-s)</option>
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
26 </param>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
27 <when value="PE">
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
28 <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
29 </when>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
30 <when value="SE" /> <!-- No extra parameters here -->
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
31 </conditional>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
32
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
33 </inputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
34 <outputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
35 <data name="output1" format="bam" />
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
36 </outputs>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
37 <tests>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
38 <test>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
39 <param name="input1" value="samtools-rmdup-input1.bam" ftype="bam" />
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
40 <param name="bam_paired_end_type_selector" value="PE" />
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
41 <param name="force_se" />
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
42 <output name="output1" file="samtools-rmdup-test1.bam" ftype="bam" sort="True" />
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
43 </test>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
44 </tests>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
45 <help>
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
46
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
47 **What it does**
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
48
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
49 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
50
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
51 -s rmdup for SE reads
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
52 -S treat PE reads as SE in rmdup (force -s)
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
53
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
54 </help>
2
3735f950b2f5 Uploaded
devteam
parents: 1
diff changeset
55 <expand macro="citations"></expand>
0
7e92b2a53aab Uploaded
devteam
parents:
diff changeset
56 </tool>