comparison geneBody_coverage.xml @ 50:f242ee103277 draft

planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 91ad241aa3f34b70649d13a5f18611da7577a5ee

49:6b33e31bda10

<tool id="rseqc_geneBody_coverage" name="Gene Body Converage (BAM)" version="2.4galaxy1">
    <description>
        Read coverage over gene body.
    </description>

    <macros>
        <import>rseqc_macros.xml</import>
    </macros>

    <requirements>
        <expand macro="requirement_package_r" />
        <expand macro="requirement_package_numpy" />
        <expand macro="requirement_package_rseqc" />
    </requirements>

    <expand macro="stdio" />

    <version_command><![CDATA[geneBody_coverage.py --version]]></version_command>

    <command><![CDATA[
        #set $safename = ''.join(c in '_0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' and c or '_' for c in $input.display_name)
        #set $fname = "d1_" + str($safename) + ".bam"
        ln -s '${input}' '${fname}' &&
        ln -s '${input.metadata.bam_index}' '${fname}.bai' &&
        echo '${fname}' > input_list.txt &&
        #for $i, $additional_input in enumerate($additionalinputs):
            #set $index = $i+2
            #set $safename = ''.join(c in '_0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' and c or '_' for c in $additional_input.file.display_name)
            #set $fname = 'd' + str($index) + '_' + str($safename) + ".bam"
            ln -s '$additional_input.file' '${fname}' &&
            ln -s '$additional_input.file.metadata.bam_index' '${fname}.bai' &&
            echo '${fname}' >> input_list.txt &&
        #end for
        geneBody_coverage.py -i input_list.txt -r $refgene --minimum_length $minimum_length -o output
        ]]>
    </command>

    <inputs>
        <param name="input" type="data" label="Input .bam File" format="bam" help="(--input-file)"/>
        <repeat name="additionalinputs" title="Additional input .bam files">
            <param name="file" type="data" label="Additional input .bam file" format="bam" />
        </repeat>
        <param name="refgene" type="data" format="bed" label="reference gene model" help="(--refgene)"/>
        <param name="minimum_length" type="integer" value="100" label="Minimum mRNA length in bp (default: 100)" help="mRNA that are shorter than this value will be skipped (--minimum_length)." />
    </inputs>

    <outputs>
        <data name="outputcurvespdf" format="pdf" from_work_dir="output.geneBodyCoverage.curves.pdf" label="${tool.name} on ${on_string} (Curves PDF)" />
        <data name="outputheatmappdf" format="pdf" from_work_dir="output.geneBodyCoverage.heatMap.pdf" label="${tool.name} on ${on_string} (HeatMap PDF)">
            <filter>len(additionalinputs) >= 2</filter>
        </data>
        <data name="outputr" format="txt" from_work_dir="output.geneBodyCoverage.r" label="${tool.name} on ${on_string} (R Script)" />
        <data name="outputtxt" format="txt" from_work_dir="output.geneBodyCoverage.txt" label="${tool.name} on ${on_string} (Text)" />
    </outputs>

    <tests>
        <test>
            <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
            <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed"/>
            <output name="outputcurvespdf" file="output.geneBodyCoverage.curves.pdf"/>
            <output name="outputr" file="output.geneBodyCoverage.r"/>
            <output name="outputtxt" file="output.geneBodyCoverage.txt"/>
        </test>
        <test>
            <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
            <param name="file_0" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
            <param name="file_1" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
            <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed"/>
            <output name="outputcurvespdf" file="output2.geneBodyCoverage.curves.pdf"/>
            <output name="outputcurvespdf" file="output2.geneBodyCoverage.heatMap.pdf"/>
            <output name="outputr" file="output2.geneBodycoverage.r"/>
            <output name="outputtxt" file="output2.geneBodyCoverage.txt"/>
        </test>

    </tests>

    <help><![CDATA[
geneBody_coverage.py
++++++++++++++++++++

Read coverage over gene body. This module is used to check if read coverage is uniform and if there is any 5\'/3\' bias. This module scales all transcripts to 100 nt and calculates the number of reads covering each nucleotide position. Finally, it generates plots illustrating the coverage profile along the gene body.

If 3 or more BAM files were provided. This program generates a lineGraph and a heatmap. If fewer than 3 BAM files were provided, only lineGraph is generated. See below for examples.

When heatmap is generated, samples are ranked by the "skewness" of the coverage: Sample with best (worst) coverage will be displayed at the top (bottom) of the heatmap.
Coverage skewness was measured by `Pearson’s skewness coefficients <http://en.wikipedia.org/wiki/Skewness#Pearson.27s_skewness_coefficients>`_

    .. image:: http://rseqc.sourceforge.net/_images/geneBody_workflow.png
        :width: 800 px
        :scale: 80 %


Inputs
++++++++++++++

Input BAM/SAM file
	Alignment file in BAM/SAM format.

Reference gene model
	Gene Model in BED format.

Minimum mRNA length
    Minimum mRNA length (bp). mRNA that are shorter than this value will be skipped (default is 100).

Outputs
++++++++++++++
Text
    Table that includes the data used to generate the plots

R Script
    R script file that reads the data and generates the plot

PDF
    The final plot, in PDF format

Example plots:
    .. image:: http://rseqc.sourceforge.net/_images/Aug_26.geneBodyCoverage.curves.png
        :height: 600 px
        :width: 600 px
        :scale: 80 %

    .. image:: http://rseqc.sourceforge.net/_images/Aug_26.geneBodyCoverage.heatMap.png
        :height: 600 px
        :width: 600 px
        :scale: 80 %

-----

About RSeQC
+++++++++++

The RSeQC_ package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. "Basic modules" quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while "RNA-seq specific modules" investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.

The RSeQC package is licensed under the GNU GPL v3 license.

.. image:: http://rseqc.sourceforge.net/_static/logo.png

.. _RSeQC: http://rseqc.sourceforge.net/
]]>
    </help>

    <expand macro="citations" />

</tool>

50:f242ee103277

<tool id="rseqc_geneBody_coverage" name="Gene Body Converage (BAM)" version="2.4galaxy2">
  <description>
    Read coverage over gene body.
  </description>

  <macros>
    <import>rseqc_macros.xml</import>
  </macros>

  <requirements>
    <expand macro="requirement_package_r" />
    <expand macro="requirement_package_numpy" />
    <expand macro="requirement_package_rseqc" />
  </requirements>

  <expand macro="stdio" />

  <version_command><![CDATA[geneBody_coverage.py --version]]></version_command>

  <command><![CDATA[
    #for $i, $input in enumerate($inputs):
    #set $index = $i+1
    #set $safename = ''.join(c in '_0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' and c or '_' for c in $input.display_name)
    #set $fname = 'd' + str($index) + '_' + str($safename) + ".bam"
    ln -s '$input' '${fname}' &&
    ln -s '$input.metadata.bam_index' '${fname}.bai' &&
    echo '${fname}' >> input_list.txt &&
    #end for
    geneBody_coverage.py -i input_list.txt -r $refgene --minimum_length $minimum_length -o output
    ]]>
  </command>

  <inputs>
    <param name="inputs" type="data" label="Input .bam File(s)" format="bam" help="(--input-file)" multiple="true"/>
    <param name="refgene" type="data" format="bed" label="reference gene model" help="(--refgene)"/>
    <param name="minimum_length" type="integer" value="100" label="Minimum mRNA length in bp (default: 100)" help="mRNA that are shorter than this value will be skipped (--minimum_length)." />
  </inputs>

  <outputs>
    <data name="outputcurvespdf" format="pdf" from_work_dir="output.geneBodyCoverage.curves.pdf" label="${tool.name} on ${on_string} (Curves PDF)" />
    <data name="outputheatmappdf" format="pdf" from_work_dir="output.geneBodyCoverage.heatMap.pdf" label="${tool.name} on ${on_string} (HeatMap PDF)">
      <filter>len(inputs) >= 3</filter>
    </data>
    <data name="outputr" format="txt" from_work_dir="output.geneBodyCoverage.r" label="${tool.name} on ${on_string} (R Script)" />
    <data name="outputtxt" format="txt" from_work_dir="output.geneBodyCoverage.txt" label="${tool.name} on ${on_string} (Text)" />
  </outputs>

  <!-- PDF Files contain R version, must avoid checking for diff -->
  <tests>
    <test>
      <param name="inputs" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
      <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed"/>
      <!-- <output name="outputcurvespdf" file="output.geneBodyCoverage.curves.pdf"/> -->
      <output name="outputr" file="output.geneBodyCoverage.r"/>
      <output name="outputtxt" file="output.geneBodyCoverage.txt"/>
    </test>
    <test>
      <param name="inputs" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam,pairend_strandspecific_51mer_hg19_chr1_1-100000.bam,pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
      <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed"/>
      <!-- <output name="outputcurvespdf" file="output2.geneBodyCoverage.curves.pdf"/> -->
      <!-- <output name="outputheatmappdf" file="output2.geneBodyCoverage.heatMap.pdf"/> -->
      <output name="outputr" file="output2.geneBodycoverage.r"/>
      <output name="outputtxt" file="output2.geneBodyCoverage.txt"/>
    </test>

  </tests>

  <help><![CDATA[
    ## geneBody_coverage.py

    Read coverage over gene body. This module is used to check if read coverage is uniform and if there is any 5\'/3\' bias. This module scales all transcripts to 100 nt and calculates the number of reads covering each nucleotide position. Finally, it generates plots illustrating the coverage profile along the gene body.

    If 3 or more BAM files were provided. This program generates a lineGraph and a heatmap. If fewer than 3 BAM files were provided, only lineGraph is generated. See below for examples.

    When heatmap is generated, samples are ranked by the "skewness" of the coverage: Sample with best (worst) coverage will be displayed at the top (bottom) of the heatmap.
    Coverage skewness was measured by `Pearson’s skewness coefficients <http://en.wikipedia.org/wiki/Skewness#Pearson.27s_skewness_coefficients>`_

    .. image:: http://rseqc.sourceforge.net/_images/geneBody_workflow.png
    :width: 800 px
    :scale: 80 %


    ## Inputs

    Input BAM/SAM file
    Alignment file in BAM/SAM format.

    Reference gene model
    Gene Model in BED format.

    Minimum mRNA length
    Minimum mRNA length (bp). mRNA that are shorter than this value will be skipped (default is 100).

    ## Outputs

    Text
    Table that includes the data used to generate the plots

    R Script
    R script file that reads the data and generates the plot

    PDF
    The final plot, in PDF format

    Example plots:
    .. image:: http://rseqc.sourceforge.net/_images/Aug_26.geneBodyCoverage.curves.png
    :height: 600 px
    :width: 600 px
    :scale: 80 %

    .. image:: http://rseqc.sourceforge.net/_images/Aug_26.geneBodyCoverage.heatMap.png
    :height: 600 px
    :width: 600 px
    :scale: 80 %

    ## About RSeQC

    The RSeQC_ package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. "Basic modules" quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while "RNA-seq specific modules" investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.

    The RSeQC package is licensed under the GNU GPL v3 license.

    .. image:: http://rseqc.sourceforge.net/_static/logo.png

    .. _RSeQC: http://rseqc.sourceforge.net/
    ]]>
  </help>

  <expand macro="citations" />

</tool>