annotate sam_merge.xml @ 0:2a36d975b360 draft

Uploaded tool tarball.
author devteam
date Tue, 20 Aug 2013 11:57:35 -0400
parents
children b874baf48b95
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="sam_merge2" name="Merge BAM Files" version="1.1.2">
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description>merges BAM files together</description>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="1.56.0">picard</requirement>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
6 <command>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
7 java -Xmx2G -jar \$JAVA_JAR_PATH/MergeSamFiles.jar MSD=$mergeSD VALIDATION_STRINGENCY=LENIENT O=$output1 I=$input1 I=$input2 TMP_DIR=$__new_file_path__
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
8 #for $i in $inputs
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
9 I=${i.input}
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
10 #end for
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
11 2&gt; $outlog
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
12 || echo "Error running Picard MergeSamFiles" >&amp;2
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
13 </command>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
14 <inputs>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
15 <param name="title" label="Name for the output merged bam file" type="text" default="Merged.bam"
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
16 help="This name will appear in your history so use it to remember what the new file in your history contains" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
17 <param name="mergeSD" value="true" type="boolean" label="Merge all component bam file headers into the merged bam file"
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
18 truevalue="true" falsevalue="false" checked="yes"
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
19 help="Control the MERGE_SEQUENCE_DICTIONARIES flag for Picard MergeSamFiles. Default (true) correctly propagates read groups and other important metadata" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
20 <param name="input1" label="First file" type="data" format="bam,sam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
21 <param name="input2" label="with file" type="data" format="bam,sam" help="Need to add more files? Use controls below." />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
22 <repeat name="inputs" title="Input Files">
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
23 <param name="input" label="Add file" type="data" format="bam,sam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
24 </repeat>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
25 </inputs>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
26 <outputs>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
27 <data format="bam" name="output1" label="${title}.bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
28 <data format="txt" name="outlog" label="${title}_${tool.name}.log" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
29 </outputs>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
30 <tests>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
31 <!-- TODO: add ability to test framework to test without at least
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
32 one repeat element value
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
33 -->
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
34 <test>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
35 <param name="title" value="test1" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
36 <param name="mergeSD" value="true" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
37 <param name="input1" value="sam_merge_in1.bam" ftype="bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
38 <param name="input2" value="sam_merge_in2.bam" ftype="bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
39 <output name="output1" file="sam_merge_out1.bam" ftype="bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
40 <output name="outlog" file="sam_merge_out1.log" ftype="txt" lines_diff="11"/>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
41 </test>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
42 <test>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
43 <param name="title" value="test2" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
44 <param name="mergeSD" value="true" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
45 <param name="input1" value="sam_merge_in1.bam" ftype="bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
46 <param name="input2" value="sam_merge_in2.bam" ftype="bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
47 <param name="input" value="sam_merge_in3.bam" ftype="bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
48 <output name="output1" file="sam_merge_out2.bam" ftype="bam" />
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
49 <output name="outlog" file="sam_merge_out2.log" ftype="txt" lines_diff="11"/>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
50 </test>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
51 </tests>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
52 <help>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
53
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
54 **What it does**
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
55
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
56 This tool uses the Picard_ merge command to merge any number of BAM files together into one BAM file while preserving the BAM
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
57 metadata such as read groups
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
58
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
59 .. _Picard: http://picard.sourceforge.net/command-line-overview.shtml#MergeSamFiles
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
60
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
61 </help>
2a36d975b360 Uploaded tool tarball.
devteam
parents:
diff changeset
62 </tool>