annotate sam_merge.xml @ 1:b874baf48b95 draft default tip

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:30:21 -0400
parents 2a36d975b360
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
1 <tool id="sam_merge2" name="Merge BAM Files" version="1.2.0">
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
2 <description>merges BAM files together</description>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
3 <requirements>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
4 <requirement type="package" version="1.56.0">picard</requirement>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
5 </requirements>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
6 <stdio>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
7 <exit_code range="1:" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
8 <exit_code range=":-1" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
9 <regex match="Error:" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
10 <regex match="Exception:" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
11 </stdio>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
12 <command>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
13 <![CDATA[
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
14 java -Xmx2G
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
15 -jar \$JAVA_JAR_PATH/MergeSamFiles.jar
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
16 MSD=$mergeSD
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
17 VALIDATION_STRINGENCY=LENIENT
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
18 O="$output1"
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
19 TMP_DIR=$__new_file_path__
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
20 #for $input in $inputs
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
21 I="${input}"
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
22 #end for
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
23 ]]>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
24 </command>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
25 <inputs>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
26 <param name="inputs" type="data" format="bam,sam" multiple="True" label="Files to merge" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
27 <param name="mergeSD" type="boolean" label="Merge all component bam file headers into the merged bam file"
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
28 truevalue="true" falsevalue="false" checked="yes"
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
29 help="Control the MERGE_SEQUENCE_DICTIONARIES flag for Picard MergeSamFiles. Default (true) correctly propagates read groups and other important metadata" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
30 </inputs>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
31 <outputs>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
32 <data format="bam" name="output1" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
33 </outputs>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
34 <tests>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
35 <test>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
36 <param name="mergeSD" value="true" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
37 <param name="inputs" value="sam_merge_in1.bam,sam_merge_in2.bam" ftype="bam" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
38 <output name="output1" file="sam_merge_out1.bam" ftype="bam" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
39 </test>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
40 <test>
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
41 <param name="mergeSD" value="true" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
42 <param name="inputs" value="sam_merge_in1.bam,sam_merge_in2.bam,sam_merge_in3.bam" ftype="bam" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
43 <output name="output1" file="sam_merge_out2.bam" ftype="bam" />
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
44 </test>
0
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
45 </tests>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
46 <help>
1
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
47 <![CDATA[
0
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
48 **What it does**
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
49
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
50 This tool uses the Picard_ merge command to merge any number of BAM files together into one BAM file while preserving the BAM
1
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
51 metadata such as read groups.
0
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
52
1
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
53 .. _Picard: http://broadinstitute.github.io/picard/
b874baf48b95 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 0
diff changeset
54 ]]>
0
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
55 </help>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
56 </tool>