annotate samtools_split.xml @ 0:57f3e32f809d draft

Uploaded
author devteam
date Tue, 21 Apr 2015 17:44:16 -0400
parents
children b7f7826ef1cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
57f3e32f809d Uploaded
devteam
parents:
diff changeset
1 <tool id="samtools_split" name="Split" version="1.1">
57f3e32f809d Uploaded
devteam
parents:
diff changeset
2 <description>BAM dataset on readgroups</description>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
3 <macros>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
4 <import>macros.xml</import>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
5 </macros>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
6 <expand macro="requirements"></expand>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
7 <expand macro="stdio"></expand>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
8 <expand macro="version_command"></expand>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
9 <command><![CDATA[
57f3e32f809d Uploaded
devteam
parents:
diff changeset
10 samtools split -f 'Read_Group_%!.bam'
57f3e32f809d Uploaded
devteam
parents:
diff changeset
11 #if $header:
57f3e32f809d Uploaded
devteam
parents:
diff changeset
12 -u "${output}":"${header}"
57f3e32f809d Uploaded
devteam
parents:
diff changeset
13 #else:
57f3e32f809d Uploaded
devteam
parents:
diff changeset
14 -u "${output}"
57f3e32f809d Uploaded
devteam
parents:
diff changeset
15 #end if
57f3e32f809d Uploaded
devteam
parents:
diff changeset
16 "${input_bam}"
57f3e32f809d Uploaded
devteam
parents:
diff changeset
17 ]]></command>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
18 <inputs>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
19 <param name="input_bam" type="data" format="bam" label="BAM file" />
57f3e32f809d Uploaded
devteam
parents:
diff changeset
20 <param name="header" type="data" format="bam,sam" label="Replace header in output file" optional="True" />
57f3e32f809d Uploaded
devteam
parents:
diff changeset
21 </inputs>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
22 <outputs>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
23 <data format="bam" name="output" label="${tool.name} on ${on_string}">
57f3e32f809d Uploaded
devteam
parents:
diff changeset
24 <discover_datasets pattern="Read_Group_(?P&lt;designation&gt;.+)\.bam" ext="bam" visible="true" directory="" />
57f3e32f809d Uploaded
devteam
parents:
diff changeset
25 </data>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
26 </outputs>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
27 <tests>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
28 <test>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
29 <param name="input_bam" value="phiX.bam" ftype="bam" />
57f3e32f809d Uploaded
devteam
parents:
diff changeset
30 <output name="output" file="samtools_split_out.bam">
57f3e32f809d Uploaded
devteam
parents:
diff changeset
31 <discovered_dataset designation="Mouse" ftype="bam" file="phiX_Mouse.bam" />
57f3e32f809d Uploaded
devteam
parents:
diff changeset
32 <discovered_dataset designation="Elephant" ftype="bam" file="phiX_Elephant.bam" />
57f3e32f809d Uploaded
devteam
parents:
diff changeset
33 <discovered_dataset designation="Human" ftype="bam" file="phiX_Human.bam" />
57f3e32f809d Uploaded
devteam
parents:
diff changeset
34 </output>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
35 </test>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
36 </tests>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
37 <help>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
38 **What it does**
57f3e32f809d Uploaded
devteam
parents:
diff changeset
39
57f3e32f809d Uploaded
devteam
parents:
diff changeset
40 Splits BAM files on readgroups.
57f3e32f809d Uploaded
devteam
parents:
diff changeset
41
57f3e32f809d Uploaded
devteam
parents:
diff changeset
42 This tool is based on ``samtools split`` command. It will generate multiple output datasets for each redagroup from the input dataset.
57f3e32f809d Uploaded
devteam
parents:
diff changeset
43
57f3e32f809d Uploaded
devteam
parents:
diff changeset
44 </help>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
45 <expand macro="citations"></expand>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
46 </tool>
57f3e32f809d Uploaded
devteam
parents:
diff changeset
47