view deseq2.xml @ 8:57e2f9454d9e draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/deseq2 commit 50db5cdaef2ff3e54a63670108eb6e4ade2a630f

<tool id="deseq2" name="DESeq2" version="2.11.39">
    <description>Determines differentially expressed features from count tables</description>
    <requirements>
        <requirement type="package" version="1.14.1">bioconductor-deseq2</requirement>
    </requirements>
    <stdio>
        <regex match="Execution halted"
           source="both"
           level="fatal"
           description="Execution halted." />
        <regex match="Error in"
           source="both"
           level="fatal"
           description="An undefined error occurred, please check your input carefully and contact your administrator." />
        <regex match="Fatal error"
           source="both"
           level="fatal"
           description="An undefined error occurred, please check your input carefully and contact your administrator." />
    </stdio>
    <version_command>
    <![CDATA[
        echo $(R --version | grep version | grep -v GNU)", DESeq2 version" $(R --vanilla --slave -e "library(DESeq2); cat(sessionInfo()\$otherPkgs\$DESeq2\$Version)" 2> /dev/null | grep -v -i "WARNING: ")
    ]]>
    </version_command>
    <command>
    <![CDATA[
        #if $tximport.tximport_selector == 'tximport':
            #if $tximport.mapping_format.mapping_format_selector == 'gtf':
                ln -s '$tximport.mapping_format.gtf_file' mapping.gtf &&
            #else:
                ln -s '$tximport.mapping_format.tabular_file' mapping.txt &&
            #end if
        #end if

        #import json
        Rscript '${__tool_directory__}/deseq2.R'
            -o '$deseq_out'
            #if $pdf:
                -p '$plots'
            #end if
            #if $normCounts:
                -n '$counts_out'
            #end if
            #set $temp_factor_names = list()
            #for $factor in $rep_factorName:
                #set $temp_factor = list()
                #for $level in $factor.rep_factorLevel:
                    #set $count_files = list()
                    #for $file in $level.countsFile:
                        $count_files.append(str($file))
                    #end for
                    $temp_factor.append( {str($level.factorLevel): $count_files} )
                #end for
                $temp_factor.reverse()
                $temp_factor_names.append([str($factor.factorName), $temp_factor])
            #end for
            -f '#echo json.dumps(temp_factor_names)#'
            -t '$fit_type'
            #if $outlier_replace_off:
                -a
            #end if
            #if $outlier_filter_off:
                -b
            #end if
            #if $auto_mean_filter_off:
                -c
            #end if
            #if $many_contrasts:
                -m
            #end if
            #if $tximport.tximport_selector == 'tximport':
                -i
                #if $tximport.mapping_format.mapping_format_selector == 'gtf':
                    -x mapping.gtf
                #else:
                    -x mapping.txt
                #end if

            #end if
    ]]>
    </command>
    <inputs>
        <repeat name="rep_factorName" title="Factor" min="1">
            <param name="factorName" type="text" value="FactorName" label="Specify a factor name, e.g. effects_drug_x or cancer_markers"
                help="Only letters, numbers and underscores will be retained in this field">
                <sanitizer>
                    <valid initial="string.letters,string.digits"><add value="_" /></valid>
                </sanitizer>
            </param>
            <repeat name="rep_factorLevel" title="Factor level" min="2" default="2">
                <param name="factorLevel" type="text" value="FactorLevel" label="Specify a factor level, typical values could be 'tumor', 'normal', 'treated' or 'control'"
                    help="Only letters, numbers and underscores will be retained in this field">
                    <sanitizer>
                        <valid initial="string.letters,string.digits"><add value="_" /></valid>
                    </sanitizer>
                </param>
                <param name="countsFile" type="data" format="tabular" multiple="true" label="Counts file(s)"/>
            </repeat>
        </repeat>

        <conditional name="tximport">
            <param name="tximport_selector" type="select" label="Choice of Input data">
                <option value="count" selected="True">Count data (e.g. from htseq-count or feature-count)</option>
                <option value="tximport">TPM values (e.g. from sailfish or salmon)</option>
            </param>
            <when value="tximport">
                <conditional name="mapping_format">
                    <param name="mapping_format_selector" type="select" label="Gene mapping format">
                        <option value="gtf" selected="True">GTF</option>
                        <option value="tabular">Transcript-ID and Gene-ID mapping file</option>
                    </param>
                    <when value="gtf">
                        <param name="gtf_file" type="data" format="gtf" label="GTF file with Transcript - Gene mapping"/>
                    </when>
                    <when value="tabular">
                        <param name="tabular_file" type="data" format="tabular" label="Tabular file with Transcript - Gene mapping"/>
                    </when>
                </conditional>
            </when>
            <when value="count" />
        </conditional>
        <param name="pdf" type="boolean" truevalue="1" falsevalue="0" checked="true"
            label="Visualising the analysis results"
            help="output an additional PDF files" />
        <param name="normCounts" type="boolean" truevalue="1" falsevalue="0" checked="false"
            label="Output normalized counts table" />
        <param name="many_contrasts" type="boolean" truevalue="1" falsevalue="0" checked="false"
            label="Output all levels vs all levels of primary factor (use when you have >2 levels for primary factor)"
            help=" DESeq2 performs independent filtering by default using the mean of normalized counts as a filter statistic" />
        <param name="fit_type" type="select" label="Fit type">
            <option value="1" selected="true">parametric</option>
            <option value="2">local</option>
            <option value="3">mean</option>
        </param>
        <param name="outlier_replace_off" type="boolean" truevalue="1" falsevalue="0" checked="false"
            label="Turn off outliers replacement (only affects with >6 replicates)"
            help="When there are more than 6 replicates for a given sample, the DESeq2 will automatically replace
                counts with large Cook’s distance with the trimmed mean over all samples, scaled up by the size factor
                or normalization factor for that sample" />
        <param name="outlier_filter_off" type="boolean" truevalue="1" falsevalue="0" checked="false"
            label="Turn off outliers filtering (only affects with >2 replicates)"
            help="When there are more than 2 replicates for a given sample, the DESeq2 will automatically
                filter genes which contain a Cook’s distance above a cutoff" />
        <param name="auto_mean_filter_off" type="boolean" truevalue="1" falsevalue="0" checked="false"
            label="Turn off independent filtering"
            help=" DESeq2 performs independent filtering by default using the mean of normalized counts as a filter statistic" />
    </inputs>
    <outputs>
        <data format="tabular" name="deseq_out" label="DESeq2 result file on ${on_string}">
            <filter>many_contrasts is False</filter>
            <actions>
                <action name="column_names" type="metadata" default="GeneID,Base mean,log2(FC),StdErr,Wald-Stats,P-value,P-adj" />
            </actions>
        </data>
        <collection name="split_output" type="list" label="DESeq2 result files on ${on_string}">
            <filter>many_contrasts is True</filter>
            <discover_datasets pattern="None.(?P&lt;designation&gt;.+_vs_.+)" format="tabular" directory="." visible="false"/>
        </collection>
        <data format="pdf" name="plots" label="DESeq2 plots on ${on_string}">
            <filter>pdf == True</filter>
        </data>
        <data format="tabular" name="counts_out" label="Normalized counts file on ${on_string}">
            <filter>normCounts == True</filter>
        </data>
    </outputs>
    <tests>
        <test>
            <repeat name="rep_factorName">
                <param name="factorName" value="Treatment"/>
                <repeat name="rep_factorLevel">
                    <param name="factorLevel" value="Treated"/>
                    <param name="countsFile" value="GSM461179_treat_single.counts,GSM461180_treat_paired.counts,GSM461181_treat_paired.counts"/>
                </repeat>
                <repeat name="rep_factorLevel">
                    <param name="factorLevel" value="Untreated"/>
                    <param name="countsFile" value="GSM461176_untreat_single.counts,GSM461177_untreat_paired.counts,GSM461178_untreat_paired.counts,GSM461182_untreat_single.counts"/>
                </repeat>
            </repeat>
            <param name="pdf" value="False"/>
            <param name="normCounts" value="True"/>
            <output name="counts_out" file="normalized_readcounts.tab"/>
            <output name="deseq_out" file="deseq2_out.tab"/>
        </test>
        <test>
            <repeat name="rep_factorName">
                <param name="factorName" value="Treatment"/>
                <repeat name="rep_factorLevel">
                    <param name="factorLevel" value="Treated"/>
                    <param name="countsFile" value="sailfish_quant_result1.tab,sailfish_quant_result2.tab"/>
                </repeat>
                <repeat name="rep_factorLevel">
                    <param name="factorLevel" value="Untreated"/>
                    <param name="countsFile" value="sailfish_quant_result3.tab,sailfish_quant_result4.tab"/>
                </repeat>
            </repeat>
            <param name="pdf" value="False"/>
            <param name="tximport_selector" value="tximport"/>
            <param name="mapping_format_selector" value="gtf"/>
            <param name="gtf_file" value="genes_sub.gtf"/>
            <output name="deseq_out" file="deseq2_tximport_out.tab"/>
        </test>
    </tests>
    <help>
<![CDATA[
.. class:: infomark

**What it does**

Estimate variance-mean dependence in count data from high-throughput sequencing assays and test for differential expression based on a model using the negative binomial distribution

**Inputs**

DESeq2_ takes count tables that generated from the htseq-count as input. Count tables must be generated for each sample individually. DESeq2 is capable of handling multiple factors that effect your experiment. The first factor you input is considered as the primary factor that affects gene expressions. You also input several secondary factors that might influence your experiment. But the final output will be changes in genes due to primary factor in presence of secondary factors. Each factor has two levels/states. You need to select appropriate count table from your history for each factor level.

The following table gives some examples of factors and their levels:

========= ============== ===============
Factor    Factor level 1 Factor level 2
--------- -------------- ---------------
Treatment Treated        Untreated
--------- -------------- ---------------
Condition Knockdown      Wildtype
--------- -------------- ---------------
TimePoint Day4           Day1
--------- -------------- ---------------
SeqType   SingleEnd      PairedEnd
--------- -------------- ---------------
Gender    Female         Male
========= ============== ===============

*Note*: Output log2 fold changes are based on primary factor level 1 vs. factor level2. Here the order of factor levels is important. For example, for the factor 'Treatment' given in above table, DESeq2 computes fold changes of 'Treated' samples against 'Untreated', i.e. the values correspond to up or down regulations of genes in Treated samples.

**Output**

DESeq2_ generates a tabular file containing the different columns and optional visualized results as PDF.

====== ==========================================================
Column Description
------ ----------------------------------------------------------
     1 Gene Identifiers
     2 mean normalised counts, averaged over all samples from both conditions
     3 the logarithm (to basis 2) of the fold change (See the note in inputs section)
     4 standard error estimate for the log2 fold change estimate
     5 Wald statistic
     6 p value for the statistical significance of this change
     7 p value adjusted for multiple testing with the Benjamini-Hochberg procedure
       which controls false discovery rate (FDR)
====== ==========================================================

.. _DESeq2: http://master.bioconductor.org/packages/release/bioc/html/DESeq2.html
]]>
    </help>
    <citations>
        <citation type="doi">10.1186/s13059-014-0550-8</citation>
    </citations>
</tool>