view picard_MergeVcfs.xml @ 18:960090a64944 draft

Uploaded

<tool id="picard_mergevcfs" name="Merge Vcfs files" version="1.106.0">
    <!-- Documentation: http://picard.sourceforge.net/command-line-overview.shtml#MergeVcfs
Merges multiple SAM/BAM files into one file.
-->
  <description>Merges multiple VCF or BCF files into one VCF file. </description>
  
  <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
  
  <command>
  java -Xmx4G -jar \$JAVA_JAR_PATH/MergeVcfs.jar I=$input1 I=$input2 O=$output1
      #for $i in $inputs
        I=${i.input}
      #end for 
  </command>
  
  <inputs>
    <param name="title" label="Name for the output merged vcf file" type="text" default="Merged.vcf"
       help="This name will appear in your history so use it to remember what the new file in your history contains" >
    </param>
    <param name="outformat" type="select" label="Output format" >
      <option value="vcf" selected="True">VCF</option>
      <option value="bcf">BCF</option>
    </param>
    <param name="input1" label="First file" type="data" format="vcf,bcf" />
    <param name="input2" label="with file" type="data" format="vcf,bcf" help="Need to add more files? Use controls below." />
    <repeat name="inputs" title="Input Files">
      <param name="input" label="Add file" type="data" format="vcf,bcf" />
    </repeat>
  </inputs>
  <outputs>
    <data format="vcf" name="output1" label="${title}.vcf" >
    </data>
    <data format="txt" name="outlog" label="${title}_${tool.name}.log" />
  </outputs>
  <tests>
    <!-- TODO: add ability to test framework to test without at least 
         one repeat element value
    -->
    <test>
      <param name="title" value="test1" />
      <param name="mergeSD" value="true" />
      <param name="input1" value="sam_merge_in1.bam" ftype="bam" /> 
      <param name="input2" value="sam_merge_in2.bam" ftype="bam" />
      <output name="output1" file="sam_merge_out1.bam" ftype="bam" />
      <output name="outlog" file="sam_merge_out1.log" ftype="txt" lines_diff="11"/>
    </test>
    <test>
      <param name="title" value="test2" />
      <param name="mergeSD" value="true" />
      <param name="input1" value="sam_merge_in1.bam" ftype="bam" /> 
      <param name="input2" value="sam_merge_in2.bam" ftype="bam" />
      <param name="input" value="sam_merge_in3.bam" ftype="bam" />
      <output name="output1" file="sam_merge_out2.bam" ftype="bam" />
      <output name="outlog" file="sam_merge_out2.log" ftype="txt" lines_diff="11"/>
    </test>
  </tests>
  <help>

**What it does**

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.

.. _Picard: http://picard.sourceforge.net/command-line-overview.shtml#MergeVcfs

  </help>
</tool>