annotate picard_ReplaceSamHeader.xml @ 8:3a3234d7a2e8 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty

<tool name="ReplaceSamHeader" id="picard_ReplaceSamHeader" version="@TOOL_VERSION@.0">
  <description>replace header in a SAM/BAM dataset</description>
  <macros>
    <import>picard_macros.xml</import>
  </macros>
  <expand macro="requirements" />
  <command>
    @java_options@
    
  
    ## Two lines below are due to the fact that picard likes fasta files to have extension .fa  
    #set $fasta_file="local_fasta.fa"
    ln -s "${inputFile}" "${fasta_file}" &amp;&amp;    
    
    java -jar \$JAVA_JAR_PATH/picard.jar
    ReplaceSamHeader
    
    INPUT="${inputFile}"
    HEADER="${header}"
    OUTPUT="${outFile}"
    
    QUIET=true
    VERBOSITY=ERROR
  
  </command>
  <inputs>
    <param format="sam,bam" name="inputFile" type="data" label="Select SAM/BAM dataset or dataset collection (header recepient dataset)" help="If empty, upload or import a SAM/BAM dataset"/>
    <param name="header" type="data" format="sam,bam" label="SAM/BAM dataset from which Header will be read (header source dataset)" help="HEADER; If empty, upload or import a SAM/BAM dataset"/>
  </inputs> 
  
  <outputs>
    <data format="bam" name="outFile" label="${tool.name} on ${on_string}: BAM file with replaced header"/>
  </outputs>
  
  <tests>
    <test>
      <param name="inputFile" value="picard_ReplaceSamHeader.bam" ftype="bam"/>
      <param name="header" value="picard_ReplaceSamHeader_header.bam" ftype="bam"/>
      <output name="outFile" file="picard_ReplaceSamHeader_test1.bam" ftype="bam"/>
    </test>
  </tests>
  
  <stdio>
    <exit_code range="1:"  level="fatal"/>
  </stdio>
  
  <help>

**Purpose**

Replace the SAMFileHeader in a SAM/BAM dataset with the given header. Validation is minimal. It is up to the user to ensure that all the elements referred to in the SAMRecords are present in the new header. Sort order of the two input datasets must be the same.
@dataset_collections@

@description@

  HEADER=File                   SAM file from which SAMFileHeader will be read.  Required. 

@more_info@

  </help>
</tool>