annotate bam_to_sam.xml @ 0:c9e926d9d87e draft

Uploaded tool tarball with dependencies.
author devteam
date Tue, 20 Aug 2013 09:19:46 -0400
parents
children 38859774da87
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
1 <tool id="bam_to_sam" name="BAM-to-SAM" version="1.0.3">
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
2 <requirements>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
3 <requirement type="package" version="0.1.18">samtools</requirement>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
4 </requirements>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
5 <description>converts BAM format to SAM format</description>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
6 <command interpreter="python">
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
7 bam_to_sam.py
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
8 --input1=$input1
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
9 --output1=$output1
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
10 $header
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
11 </command>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
12 <inputs>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
13 <param name="input1" type="data" format="bam" label="BAM File to Convert" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
14 <param name="header" type="boolean" truevalue="--header" falsevalue="" checked="False" label="Include header in output" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
15 </inputs>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
16 <outputs>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
17 <data format="sam" name="output1" label="${tool.name} on ${on_string}: converted SAM" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
18 </outputs>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
19 <tests>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
20 <test>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
21 <!--
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
22 Bam-to-Sam command:
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
23 samtools view -o bam_to_sam_out1.sam test-data/bam_to_sam_in1.bam
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
24 bam_to_sam_in1.bam can be created from bam_to_sam_in1.sam
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
25 -->
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
26 <param name="input1" value="bam_to_sam_in1.bam" ftype="bam" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
27 <param name="header" value="" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
28 <output name="output1" file="bam_to_sam_out1.sam" sorted="True" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
29 </test>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
30 <test>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
31 <!--
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
32 Bam-to-Sam command:
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
33 samtools view -o bam_to_sam_out2.sam test-data/bam_to_sam_in2.bam
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
34 bam_to_sam_in2.bam can be created from bam_to_sam_in2.sam
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
35 -->
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
36 <param name="input1" value="bam_to_sam_in2.bam" ftype="bam" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
37 <param name="header" value="" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
38 <output name="output1" file="bam_to_sam_out2.sam" sorted="True" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
39 </test>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
40 <test>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
41 <!--
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
42 Bam-to-Sam command:
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
43 samtools view -h -o bam_to_sam_out3.sam test-data/bam_to_sam_in1.bam
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
44 bam_to_sam_in1.bam can be created from bam_to_sam_in1.sam
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
45 -->
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
46 <param name="input1" value="bam_to_sam_in1.bam" ftype="bam" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
47 <param name="header" value="--header" />
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
48 <output name="output1" file="bam_to_sam_out3.sam" sorted="True" lines_diff="6" /><!-- header param not working in func tests so won't produce correct 6-line header (fine in browser) -->
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
49 </test>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
50 </tests>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
51 <help>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
52
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
53 **What it does**
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
54
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
55 This tool uses the SAMTools_ toolkit to produce a SAM file from a BAM file.
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
56
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
57 .. _SAMTools: http://samtools.sourceforge.net/samtools.shtml
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
58
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
59 ------
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
60
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
61 **Citation**
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
62
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
63 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;`_
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
64
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
65 </help>
c9e926d9d87e Uploaded tool tarball with dependencies.
devteam
parents:
diff changeset
66 </tool>