annotate volcanoplot.xml @ 8:2f557f6abbfb draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 84949ce3d77433f035c14406fccc5bc6beaa7a0d

<tool id="volcanoplot" name="Volcano Plot" version="0.0.6" profile="20.09">
    <description>create a volcano plot</description>
    <edam_topics>
        <edam_topic>topic_0092</edam_topic>
    </edam_topics>
    <edam_operations>
        <edam_operation>operation_0337</edam_operation>
    </edam_operations>
    <requirements>
        <requirement type="package" version="3.3.3">r-ggplot2</requirement>
        <requirement type="package" version="0.9.1">r-ggrepel</requirement>
        <requirement type="package" version="1.0.6">r-dplyr</requirement>
    </requirements>
    <version_command><![CDATA[
echo $(R --version | grep version | grep -v GNU)", ggplot2 version" $(R --vanilla --slave -e "library(ggplot2); cat(sessionInfo()\$otherPkgs\$ggplot2\$Version)" 2> /dev/null | grep -v -i "WARNING: ")", ggrepel version" $(R --vanilla --slave -e "library(ggrepel); cat(sessionInfo()\$otherPkgs\$ggrepel\$Version)" 2> /dev/null | grep -v -i "WARNING: ")", dplyr version" $(R --vanilla --slave -e "library(dplyr); cat(sessionInfo()\$otherPkgs\$dplyr\$Version)" 2> /dev/null | grep -v -i "WARNING: ")
    ]]></version_command>
    <command detect_errors="exit_code"><![CDATA[
    #if $out_options.rscript_out:
        cp '${volcanoplot_script}' rscript.txt &&
    #end if
    Rscript '${volcanoplot_script}'
]]></command>
    <configfiles>
        <configfile name="volcanoplot_script"><![CDATA[
# Galaxy settings start ---------------------------------------------------

# setup R error handling to go to stderr
options(show.error.messages = F, error = function() {cat(geterrmessage(), file = stderr()); q("no", 1, F)})

# we need that to not crash galaxy with an UTF8 error on German LC settings.
loc <- Sys.setlocale("LC_MESSAGES", "en_US.UTF-8")

# Galaxy settings end -----------------------------------------------------

# Load packages -----------------------------------------------------------

suppressPackageStartupMessages({
    library(dplyr)
    library(ggplot2)
    library(ggrepel)
})


# Import data  ------------------------------------------------------------

#if $header == "yes"
results <- read.delim('$input', header = TRUE)

#elif $header == "no"
results <- read.delim('$input', header = FALSE)

#else
# Auto-detect header by checking if P value column is numeric or not
first_line <- read.delim('$input', header = FALSE, nrow = 1)
first_pvalue <- first_line[, $pval_col]
if (is.numeric(first_pvalue)) {
  print("No header row detected")
  results <- read.delim('$input', header = FALSE)
} else {
  print("Header row detected")
  results <- read.delim('$input', header = TRUE)
}
#end if

# Format data  ------------------------------------------------------------

# Create columns from the column numbers specified
results <- results %>% mutate(fdr = .[[$fdr_col]],
                              pvalue = .[[$pval_col]],
                              logfc = .[[$lfc_col]],
                              labels = .[[$label_col]])

# Get names for legend
down <- unlist(strsplit('$plot_options.legend_labs', split = ","))[1]
notsig <- unlist(strsplit('$plot_options.legend_labs', split = ","))[2]
up <- unlist(strsplit('$plot_options.legend_labs', split = ","))[3]

# Set colours
colours <- setNames(c("cornflowerblue", "grey", "firebrick"), c(down, notsig, up))

# Create significant (sig) column
results <- mutate(results, sig = case_when(
                                fdr < $signif_thresh & logfc > $lfc_thresh ~ up,
                                fdr < $signif_thresh & logfc < -$lfc_thresh ~ down,
                                TRUE ~ notsig))

## R code below is left aligned for R script output

#if $labels.label_select != "none"
# Specify genes to label --------------------------------------------------

    #if $labels.label_select == "file"
# Import file with genes of interest
labelfile <- read.delim('$labels.label_file', header = TRUE)

# Label the genes of interest in results table
results <- mutate(results, labels = ifelse(labels %in% labelfile[, 1], labels, ""))

    #elif $labels.label_select == "signif"
        #if not $labels.top_num
# Label all significant genes in results table
results <- mutate(results, labels=ifelse(sig != notsig, labels, ""))

        #elif $labels.top_num > 0
# Get top genes by P value
top <- slice_min(results, order_by = pvalue, n = $labels.top_num)

# Extract into vector
toplabels <- pull(top, labels)

# Label just the top genes in results table
results <- mutate(results, labels = ifelse(labels %in% toplabels, labels, ""))
        #end if
     #end if
#end if


# Create plot -------------------------------------------------------------

# Open file to save plot as PDF
pdf("volcano_plot.pdf")

# Set up base plot
p <- ggplot(data = results, aes(x = logfc, y = -log10(pvalue))) +
    geom_point(aes(colour = sig)) +
    scale_color_manual(values = colours) +
    theme(panel.grid.major = element_blank(),
        panel.grid.minor = element_blank(),
        panel.background = element_blank(),
        axis.line = element_line(colour = "black"),
        legend.key = element_blank())

#if $labels.label_select != "none"
# Add gene labels
    #if $plot_options.boxes
p <- p + geom_label_repel(data = filter(results, labels != ""), aes(label = labels),
                          min.segment.length = 0,
                          max.overlaps = Inf,
                          show.legend = FALSE)
    #else
p <- p + geom_text_repel(data = filter(results, labels != ""), aes(label = labels),
                         min.segment.length = 0,
                         max.overlaps = Inf,
                         show.legend = FALSE)
    #end if
#end if

#if $plot_options.title:
p <- p + ggtitle('$plot_options.title')
#end if

#if $plot_options.xlab:
p <- p + xlab('$plot_options.xlab')
#end if

#if $plot_options.ylab:
p <- p + ylab('$plot_options.ylab')
#end if

#if $plot_options.xmin and $plot_options.xmax:
p <- p + xlim($plot_options.xmin, $plot_options.xmax)
#end if

#if $plot_options.ymax:
p <- p + ylim(0, $plot_options.ymax)
#end if

# Set legend title
#if $plot_options.legend:
p <- p + guides(color = guide_legend(title = '$plot_options.legend'))
#else
p <- p + theme(legend.title = element_blank())
#end if

# Print plot
print(p)

# Close PDF graphics device
dev.off()


# R and Package versions -------------------------------------------------
sessionInfo()

]]></configfile>
</configfiles>
    <inputs>
        <param name="input" type="data" format="tabular" label="Specify an input file" />
        <param name="header" type="select" label="File has header?" help="Does the differentially expressed results file contain a header row. The tool can auto-detect by checking if the first row in the P value column is a number or not. Default: Auto-detect">
            <option value="auto" selected="True">Auto-detect</option>
            <option value="yes">Yes</option>
            <option value="no">No</option>
        </param>
        <param name="fdr_col" type="data_column" data_ref="input" label="FDR (adjusted P value) column number" />
        <param name="pval_col" type="data_column" data_ref="input" label="P value (raw) column number" />
        <param name="lfc_col" type="data_column" data_ref="input" label="Log Fold Change column number" />
        <param name="label_col" type="data_column" data_ref="input" label="Labels column number" />
        <param name="signif_thresh" type="float" max="1" value="0.05" label="Significance threshold" help="Default: 0.05"/>
        <param name="lfc_thresh" type="float" value="0" label="LogFC threshold to colour" help="Default: 0"/>
        <conditional name="labels">
            <param name="label_select" type="select" label="Points to label" help="Select to label significant points or input labels from file. Default: None">
                <option value="none" selected="True">None</option>
                <option value="signif">Significant</option>
                <option value="file">Input from file</option>
            </param>
            <when value="signif">
                <param name="top_num" type="integer" optional="True" label="Only label top most significant" help="Specify the top number of points to label by P value significance. If no number is specified, all points that pass the FDR and Log Fold Change thresholds will be labelled."/>
            </when>
            <when value="file">
                <param name="label_file" type="data" format="tabular" label="File of labels"/>
            </when>
            <when value="none" />
        </conditional>
        <section name="plot_options" expanded="false" title="Plot Options">
            <param name="boxes" type="boolean" truevalue="True" falsevalue="False" checked="False" label="Label Boxes" help="If this is set to Yes, the labels for the points will be in boxes. Default: No"/>
            <param name="title" type="text" optional="True" label="Plot title"/>
            <param name="xlab" type="text" optional="True" label="Label for x axis"/>
            <param name="ylab" type="text" optional="True" label="Label for y axis"/>
            <param name="xmin" type="float" optional="True" label="Minimum value for x axis" help="To customise the x axis limits, specify both minimum and maximum values. Leave empty for automatic values."/>
            <param name="xmax" type="float" optional="True" label="Maximum value for x axis" help="To customise the x axis limits, specify both minimum and maximum values. Leave empty for automatic values."/>
            <param name="ymax" type="float" optional="True" label="Maximum value for y axis" help="To customise the y axis upper limit, specify the maximum value, the minimum will be 0. Leave empty for automatic value."/>
            <param name="legend" type="text" optional="True" label="Label for Legend Title"/>
            <param name="legend_labs" type="text" value="Down,Not Sig,Up" label="Labels for Legend" help="Labels in the legend can be specified. Default: Down,Not Sig,Up"/>
        </section>
        <section name="out_options" expanded="false" title="Output Options">
            <param name="rscript_out" type="boolean" truevalue="True" falsevalue="False" checked="False" label="Output Rscript?"
                help="Output the R code used by the tool. Can edit in R if you want to customise the plot further. Default: No"/>
        </section>
    </inputs>
    <outputs>
        <data name="plot" format="pdf" from_work_dir="volcano_plot.pdf" label="${tool.name} on ${on_string}: PDF"/>
        <data name="rscript" format="txt" from_work_dir="rscript.txt" label="${tool.name} on ${on_string}: Rscript">
            <filter>out_options['rscript_out']</filter>
        </data>
    </outputs>
    <tests>
        <test expect_num_outputs="1">
            <!-- Ensure default output works -->
            <param name="input" ftype="tabular" value="input.tab"/>
            <param name="fdr_col" value="4" />
            <param name="pval_col" value="3" />
            <param name="lfc_col" value="2" />
            <param name="label_col" value="1" />
            <param name="lfc_thresh" value="0" />
            <output name="plot">
                <assert_contents>
                    <has_size value= "933451" delta="1000" />
                </assert_contents>
            </output>
        </test>
        <test expect_num_outputs="1">
            <!-- Ensure input labels and plot options work -->
            <param name="input" ftype="tabular" value="input.tab"/>
            <param name="fdr_col" value="4" />
            <param name="pval_col" value="3" />
            <param name="lfc_col" value="2" />
            <param name="label_col" value="1" />
            <param name="lfc_thresh" value="0" />
            <param name="label_select" value="file"/>
            <param name="label_file" ftype="tabular" value="labels.tab" />
            <output name="plot">
                <assert_contents>
                    <has_size value= "933830" delta="1000" />
                </assert_contents>
            </output>
        </test>
        <test expect_num_outputs="2">
            <!-- Ensure rscript output works -->
            <param name="input" ftype="tabular" value="input.tab"/>
            <param name="header" value="yes"/>
            <param name="fdr_col" value="4" />
            <param name="pval_col" value="3" />
            <param name="lfc_col" value="2" />
            <param name="label_col" value="1" />
            <param name="lfc_thresh" value="0" />
            <param name="label_select" value="file"/>
            <param name="label_file" ftype="tabular" value="labels.tab" />
            <param name="rscript_out" value="True"/>
            <output name="plot">
                <assert_contents>
                    <has_size value= "933832" delta="1000" />
                </assert_contents>
            </output>
            <output name="rscript" value= "out.rscript" lines_diff="4"/>
        </test>
    </tests>
    <help><![CDATA[
.. class:: infomark

**What it does**

This tool creates a Volcano plot using ggplot2. Points can be labelled via ggrepel. It was inspired by this Getting Genetics Done `blog post`_.

In statistics, a `Volcano plot`_ is a type of scatter-plot that is used to quickly identify changes in large data sets composed of replicate data. It plots significance versus fold-change on the y and x axes, respectively. These plots are increasingly common in omic experiments such as genomics, proteomics, and metabolomics where one often has a list of many thousands of replicate data points between two conditions and one wishes to quickly identify the most meaningful changes. A volcano plot combines a measure of statistical significance from a statistical test (e.g., a p value from an ANOVA model) with the magnitude of the change, enabling quick visual identification of those data-points (genes, etc.) that display large magnitude changes that are also statistically significant.

A volcano plot is constructed by plotting the negative log of the p value on the y axis (usually base 10). This results in data points with low p values (highly significant) appearing toward the top of the plot. The x axis is the log of the fold change between the two conditions. The log of the fold change is used so that changes in both directions appear equidistant from the center. Plotting points in this way results in two regions of interest in the plot: those points that are found toward the top of the plot that are far to either the left- or right-hand sides. These represent values that display large magnitude fold changes (hence being left or right of center) as well as high statistical significance (hence being toward the top).

Source: Wikipedia

-----

**Inputs**

A tabular file containing the columns below (additional columns may be present):

    * P value
    * FDR / adjusted P value
    * Log fold change
    * Labels (e.g. Gene symbols or IDs)

All significant points, those meeting the specified FDR and Log Fold Change thresholds, will be coloured, red for upregulated, blue for downregulated. Users can choose to apply labels to the points (such as gene symbols) from the Labels column. To label all significant points, select "Significant" for the **Points to label** option, or to only label the top most significant specify a number under "Only label top most significant". Users can label any points of interest through selecting **Points to label** "Input from file" and providing a tabular labels file. The labels file must contain a header row and have the labels in the first column. These labels must match the labels in the main input file.

**Outputs**

A PDF containing a Volcano plot like below. The R code can be output through *Output Options* in the tool form.

.. image:: $PATH_TO_IMAGES/volcano_plot.png

.. _Volcano plot: https://en.wikipedia.org/wiki/Volcano_plot_(statistics)
.. _blog post: https://gettinggeneticsdone.blogspot.com/2016/01/

    ]]></help>
    <citations>
        <citation type="doi">10.1007/978-3-319-24277-4</citation>
    </citations>
</tool>