annotate samtools_split.xml @ 0:5c2a97bb018b draft

Uploaded initial tool definition.
author devteam
date Fri, 24 Oct 2014 16:22:16 -0400
parents
children 76449db9ee44
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
1 <tool id="samtools_split" name="Split" version="1.0.0">
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
2 <description>a BAM file by read group</description>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
3 <requirements>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
4 <requirement type="package" version="1.1">samtools</requirement>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
5 </requirements>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
6 <version_command>samtools --version | head -n 1 | awk '{ print $2 }'</version_command>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
7 <command><![CDATA[
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
8 samtools split -f 'Read_Group_%!.bam'
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
9 #if $header:
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
10 -u "${output}":"${header}"
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
11 #else:
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
12 -u "${output}"
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
13 #end if
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
14 "${input_bam}"
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
15 ]]></command>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
16 <stdio>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
17 <exit_code range="1:" level="fatal" description="Error" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
18 </stdio>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
19 <inputs>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
20 <param name="input_bam" type="data" format="bam" label="BAM file" multiple="true" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
21 <param name="header" type="data" format="bam,sam" label="Replace header in output file" optional="True" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
22 </inputs>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
23 <outputs>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
24 <data format="bam" name="output" label="${tool.name} on ${on_string}">
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
25 <discover_datasets pattern="Read_Group_(?P&lt;designation&gt;.+)\.bam" ext="bam" visible="true" directory="" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
26 </data>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
27 </outputs>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
28 <tests>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
29 <test>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
30 <param name="input_bam" value="phiX.bam" ftype="bam" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
31 <output name="output" file="samtools_split_out.bam">
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
32 <discovered_dataset designation="Mouse" ftype="bam" file="phiX_Mouse.bam" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
33 <discovered_dataset designation="Elephant" ftype="bam" file="phiX_Elephant.bam" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
34 <discovered_dataset designation="Human" ftype="bam" file="phiX_Human.bam" />
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
35 </output>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
36 </test>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
37 </tests>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
38 <help>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
39 **What it does**
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
40
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
41 This tool runs the ``samtools split`` command in the SAMtools toolkit.
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
42
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
43 Split BAM files by read group.
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
44
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
45 **Citation**
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
46
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
47 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;`_
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
48
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
49
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
50 If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
51 </help>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
52 </tool>
5c2a97bb018b Uploaded initial tool definition.
devteam
parents:
diff changeset
53