annotate samtools_rmdup.xml @ 0:27136ac45e90 draft

Uploaded
author devteam
date Tue, 20 Aug 2013 12:35:53 -0400
parents
children 75e4b89f1004
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
27136ac45e90 Uploaded
devteam
parents:
diff changeset
1 <tool id="samtools_rmdup" name="rmdup" version="1.0.0">
27136ac45e90 Uploaded
devteam
parents:
diff changeset
2 <requirements>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
3 <requirement type="package" version="0.1.18">samtools</requirement>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
4 </requirements>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
5 <description>remove PCR duplicates</description>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
6 <command>samtools rmdup
27136ac45e90 Uploaded
devteam
parents:
diff changeset
7 #if str( $bam_paired_end_type.bam_paired_end_type_selector ) == "PE"
27136ac45e90 Uploaded
devteam
parents:
diff changeset
8 ${bam_paired_end_type.force_se}
27136ac45e90 Uploaded
devteam
parents:
diff changeset
9 #else:
27136ac45e90 Uploaded
devteam
parents:
diff changeset
10 -s
27136ac45e90 Uploaded
devteam
parents:
diff changeset
11 #end if
27136ac45e90 Uploaded
devteam
parents:
diff changeset
12 "$input1" "$output1"
27136ac45e90 Uploaded
devteam
parents:
diff changeset
13 2&gt;&amp;1 || echo "Error running samtools rmdup." &gt;&amp;2
27136ac45e90 Uploaded
devteam
parents:
diff changeset
14 </command>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
15 <inputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
16 <param name="input1" type="data" format="bam" label="BAM File" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
17
27136ac45e90 Uploaded
devteam
parents:
diff changeset
18 <conditional name="bam_paired_end_type">
27136ac45e90 Uploaded
devteam
parents:
diff changeset
19 <param name="bam_paired_end_type_selector" type="select" label="Is data paired-end">
27136ac45e90 Uploaded
devteam
parents:
diff changeset
20 <option value="PE" selected="True">BAM is paired-end</option>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
21 <option value="SE">BAM is single-end</option>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
22 </param>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
23 <when value="PE">
27136ac45e90 Uploaded
devteam
parents:
diff changeset
24 <param name="force_se" type="boolean" label="Treat as single-end" help="(-S)" truevalue="-S" falsevalue="" checked="False"/>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
25 </when>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
26 <when value="SE" /> <!-- No extra parameters here -->
27136ac45e90 Uploaded
devteam
parents:
diff changeset
27 </conditional>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
28
27136ac45e90 Uploaded
devteam
parents:
diff changeset
29 </inputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
30 <outputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
31 <data name="output1" format="bam" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
32 </outputs>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
33 <tests>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
34 <test>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
35 <param name="input1" value="1.bam" ftype="bam" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
36 <param name="bam_paired_end_type_selector" value="SE" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
37 <output name="output1" file="1.bam" ftype="bam" sort="True"/>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
38 </test>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
39 <test>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
40 <param name="input1" value="1.bam" ftype="bam" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
41 <param name="bam_paired_end_type_selector" value="PE" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
42 <param name="force_se" value="True" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
43 <output name="output1" file="1.bam" ftype="bam" sort="True"/>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
44 </test>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
45 <test>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
46 <param name="input1" value="1.bam" ftype="bam" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
47 <param name="bam_paired_end_type_selector" value="PE" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
48 <param name="force_se" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
49 <output name="output1" file="1.bam" ftype="bam" sort="True" />
27136ac45e90 Uploaded
devteam
parents:
diff changeset
50 </test>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
51 </tests>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
52 <help>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
53
27136ac45e90 Uploaded
devteam
parents:
diff changeset
54 **What it does**
27136ac45e90 Uploaded
devteam
parents:
diff changeset
55
27136ac45e90 Uploaded
devteam
parents:
diff changeset
56 This tool uses the SAMTools_ toolkit to 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).
27136ac45e90 Uploaded
devteam
parents:
diff changeset
57
27136ac45e90 Uploaded
devteam
parents:
diff changeset
58 .. _SAMTools: http://samtools.sourceforge.net/samtools.shtml
27136ac45e90 Uploaded
devteam
parents:
diff changeset
59
27136ac45e90 Uploaded
devteam
parents:
diff changeset
60 ------
27136ac45e90 Uploaded
devteam
parents:
diff changeset
61
27136ac45e90 Uploaded
devteam
parents:
diff changeset
62 **Citation**
27136ac45e90 Uploaded
devteam
parents:
diff changeset
63
27136ac45e90 Uploaded
devteam
parents:
diff changeset
64 For the underlying tool, please cite `Li H, Handsaker B, Wysoker A, Fennell T, Ruan J, Homer N, Marth G, Abecasis G, Durbin R; 1000 Genome Project Data Processing Subgroup. The Sequence Alignment/Map format and SAMtools. Bioinformatics. 2009 Aug 15;25(16):2078-9. &lt;http://www.ncbi.nlm.nih.gov/pubmed/19505943&gt;`_
27136ac45e90 Uploaded
devteam
parents:
diff changeset
65
27136ac45e90 Uploaded
devteam
parents:
diff changeset
66 If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*
27136ac45e90 Uploaded
devteam
parents:
diff changeset
67
27136ac45e90 Uploaded
devteam
parents:
diff changeset
68 </help>
27136ac45e90 Uploaded
devteam
parents:
diff changeset
69 </tool>