annotate picard_MergeVcfs.xml @ 81:a6a1857f78dd draft

Uploaded
author devteam
date Thu, 20 Feb 2014 13:40:08 -0500
parents ca0e1414805c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
ca0e1414805c Uploaded
devteam
parents:
diff changeset
1 <tool id="picard_mergevcfs" name="Merge Vcfs files" version="1.106.0">
ca0e1414805c Uploaded
devteam
parents:
diff changeset
2 <!-- Documentation: http://picard.sourceforge.net/command-line-overview.shtml#MergeVcfs
ca0e1414805c Uploaded
devteam
parents:
diff changeset
3 Merges multiple SAM/BAM files into one file.
ca0e1414805c Uploaded
devteam
parents:
diff changeset
4 -->
ca0e1414805c Uploaded
devteam
parents:
diff changeset
5 <description>Merges multiple VCF or BCF files into one VCF file. </description>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
6
ca0e1414805c Uploaded
devteam
parents:
diff changeset
7 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
8
ca0e1414805c Uploaded
devteam
parents:
diff changeset
9 <command>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
10 java -Xmx4G -jar \$JAVA_JAR_PATH/MergeVcfs.jar I=$input1 I=$input2 O=$output1
ca0e1414805c Uploaded
devteam
parents:
diff changeset
11 #for $i in $inputs
ca0e1414805c Uploaded
devteam
parents:
diff changeset
12 I=${i.input}
ca0e1414805c Uploaded
devteam
parents:
diff changeset
13 #end for
ca0e1414805c Uploaded
devteam
parents:
diff changeset
14 </command>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
15
ca0e1414805c Uploaded
devteam
parents:
diff changeset
16 <inputs>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
17 <param name="title" label="Name for the output merged vcf file" type="text" default="Merged.vcf"
ca0e1414805c 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" >
ca0e1414805c Uploaded
devteam
parents:
diff changeset
19 </param>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
20 <param name="outformat" type="select" label="Output format" >
ca0e1414805c Uploaded
devteam
parents:
diff changeset
21 <option value="vcf" selected="True">VCF</option>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
22 <option value="bcf">BCF</option>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
23 </param>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
24 <param name="input1" label="First file" type="data" format="vcf,bcf" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
25 <param name="input2" label="with file" type="data" format="vcf,bcf" help="Need to add more files? Use controls below." />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
26 <repeat name="inputs" title="Input Files">
ca0e1414805c Uploaded
devteam
parents:
diff changeset
27 <param name="input" label="Add file" type="data" format="vcf,bcf" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
28 </repeat>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
29 </inputs>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
30 <outputs>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
31 <data format="vcf" name="output1" label="${title}.vcf" >
ca0e1414805c Uploaded
devteam
parents:
diff changeset
32 </data>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
33 <data format="txt" name="outlog" label="${title}_${tool.name}.log" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
34 </outputs>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
35 <tests>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
36 <!-- TODO: add ability to test framework to test without at least
ca0e1414805c Uploaded
devteam
parents:
diff changeset
37 one repeat element value
ca0e1414805c Uploaded
devteam
parents:
diff changeset
38 -->
ca0e1414805c Uploaded
devteam
parents:
diff changeset
39 <test>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
40 <param name="title" value="test1" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
41 <param name="mergeSD" value="true" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
42 <param name="input1" value="sam_merge_in1.bam" ftype="bam" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
43 <param name="input2" value="sam_merge_in2.bam" ftype="bam" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
44 <output name="output1" file="sam_merge_out1.bam" ftype="bam" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
45 <output name="outlog" file="sam_merge_out1.log" ftype="txt" lines_diff="11"/>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
46 </test>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
47 <test>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
48 <param name="title" value="test2" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
49 <param name="mergeSD" value="true" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
50 <param name="input1" value="sam_merge_in1.bam" ftype="bam" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
51 <param name="input2" value="sam_merge_in2.bam" ftype="bam" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
52 <param name="input" value="sam_merge_in3.bam" ftype="bam" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
53 <output name="output1" file="sam_merge_out2.bam" ftype="bam" />
ca0e1414805c Uploaded
devteam
parents:
diff changeset
54 <output name="outlog" file="sam_merge_out2.log" ftype="txt" lines_diff="11"/>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
55 </test>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
56 </tests>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
57 <help>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
58
ca0e1414805c Uploaded
devteam
parents:
diff changeset
59 **What it does**
ca0e1414805c Uploaded
devteam
parents:
diff changeset
60
ca0e1414805c Uploaded
devteam
parents:
diff changeset
61 Merges multiple VCF or BCF files into one VCF file. Input files must be sorted by their contigs and, within contigs, by start position. The input files must have the same sample and contig lists. An index file is created and a sequence dictionary is required by default.
ca0e1414805c Uploaded
devteam
parents:
diff changeset
62
ca0e1414805c Uploaded
devteam
parents:
diff changeset
63 .. _Picard: http://picard.sourceforge.net/command-line-overview.shtml#MergeVcfs
ca0e1414805c Uploaded
devteam
parents:
diff changeset
64
ca0e1414805c Uploaded
devteam
parents:
diff changeset
65 </help>
ca0e1414805c Uploaded
devteam
parents:
diff changeset
66 </tool>