annotate samtools_split.xml @ 18:dc66a024be19 draft default tip

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