view small_rna_map.xml @ 8:2cc2948cfa34 draft default tip

planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/small_rna_map commit b6c6b4d92a8d839e59f7ac28cb169d25ca68ef0d

<tool id="small_rna_map" name="small rna map" version="0.7.0">
  <description></description>
  <requirements>
        <requirement type="package" version="1.11.2=py27_0">numpy</requirement>
        <requirement type="package" version="0.11.2.1=py27_0">pysam</requirement>
        <requirement type="package" version="1.3.2=r3.3.1_0">r-optparse</requirement>
        <requirement type="package" version="0.6_28=r3.3.1_0">r-latticeextra</requirement>
        <requirement type="package" version="2.2.1=r3.3.1_0">r-gridextra</requirement>
  </requirements>
  <stdio>
      <exit_code range="1:" level="fatal" description="Tool exception" />
  </stdio>
  <command detect_errors="exit_code"><![CDATA[
      #for $file in $input
          samtools index '$file' &&
      #end for
      python '$__tool_directory__'/small_rna_map.py 
      --input 
      #for $file in $input
           '$file'
      #end for
          --sample_name
      #for $sample in $input
          '$sample.name'
      #end for
      #if $extra_plot == 'Sizes':
          --sizes '$output_sizes'
      #end if
      --output '$output_tab' &&
       Rscript '$__tool_directory__'/small_rna_map.r --output_tab '$output_tab' 
               --output_pdf '$output_pdf'
      #if $extra_plot != 'Sizes':
          --extra_plot '$extra_plot'
      #else
          --sizes $output_sizes
      #end if
  ]]></command>
 <inputs>
   <param name="input" type="data" format="bam" label="Select multiple alignments to parse" multiple="True"/> 
   <param name="extra_plot" type="select" label="select the type of extra plot in addition to read map">
       <option value="Coverage">Coverage</option> 
       <option value="Mean">Mean Sizes</option> 
       <option value="Median">Median Sizes</option>
       <option value="Sizes">Size Distributions</option>
    </param>
 </inputs>

 <outputs>
   <data format="tabular" name="output_tab" label="Map dataframe" />
   <data format="tabular" name="output_sizes" label="Size dataframe" >
       <filter>extra_plot == "Sizes"</filter>
   </data>
   <data format="pdf" name="output_pdf" label="PDF file" />

</outputs>

    <tests>
        <test>
            <param name="input" value="input1.bam,input2.bam" ftype="bam"/>
            <param name="extra_plot" value="Mean" />
            <output file="output.tab" name="output_tab" />
            <output file="mean.pdf" name="output_pdf" />
        </test>
        <test>
            <param name="input" value="input1.bam,input1.bam" ftype="bam"/>
            <param name="extra_plot" value="Mean" />
            <output file="doubled.tab" name="output_tab" />
            <output file="doubled_mean.pdf" name="output_pdf" />
        </test>
        <test>
            <param name="input" value="input1.bam,input2.bam" ftype="bam"/>
            <param name="extra_plot" value="Median" />
            <output file="output.tab" name="output_tab" />
            <output file="median.pdf" name="output_pdf" />
        </test>
        <test>
            <param name="input" value="input1.bam,input2.bam" ftype="bam"/>
            <param name="extra_plot" value="Coverage" />
            <output file="output.tab" name="output_tab" />
            <output file="coverage.pdf" name="output_pdf" />
        </test>
        <test>
            <param name="input" value="input1.bam,input2.bam" ftype="bam"/>
            <param name="extra_plot" value="Sizes" />
            <output file="output.tab" name="output_tab" />
            <output file="sizes.tab" name="output_sizes" />
            <output file="sizes.pdf" name="output_pdf" />
        </test>
    </tests>


<help>

**What it does**

Generate read count maps from alignment BAM files, using pysam and ggplot.
In addition to the read counts (bars), median size and mean size of reads mapping at a given position are plotted in the graphs.	

**Inputs**

bam alignment files that *must* be

  - sorted
  - mapping to the same reference

**Output**

A pdf file generated by the R package lattice

</help>

<citations>
    <citation type="doi">10.1093/bioinformatics/btp352</citation>
     <citation type="bibtex">@Book{,
    author = {Hadley Wickham},
    title = {ggplot2: Elegant Graphics for Data Analysis},
    publisher = {Springer-Verlag New York},
    year = {2009},
    isbn = {978-0-387-98140-6},
    url = {http://ggplot2.org},
   }</citation>
</citations>
</tool>