annotate picard_MergeSam.xml @ 8:ca0e1414805c draft

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