comparison volcanoplot.xml @ 1:7b7303fa20e3 draft

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

0:59ebf2c42c0e

<tool id="volcanoplot" name="Volcano Plot" version="0.0.1">
    <description>create a volcano plot</description>
    <requirements>
        <requirement type="package" version="3.0.0">r-ggplot2</requirement>
        <requirement type="package" version="0.8.0">r-ggrepel</requirement>
        <requirement type="package" version="0.7.6">r-dplyr</requirement>

    -l $label_col
    -s $signif_thresh
    -x $lfc_thresh
    #if $labels.label_select == 'file':
        -f '$labels.label_file'
    #else if $labels.top_num:
        -t $labels.top_num
    #end if
    #if $plot_options.title:
        -T '$plot_options.title'
    #end if
    #if $plot_options.xlab:

        <param name="lfc_col" type="data_column" data_ref="input" label="Log Fold Change" />
        <param name="label_col" type="data_column" data_ref="input" label="Labels" />
        <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 top significant points or input labels from file. All points meeting the significance threshold are labelled by default.">
                <option value="signif" selected="True">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"/>
            </when>
            <when value="file">
                <param name="label_file" type="data" format="tabular" label="File of labels"/>
            </when>
        </conditional>

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

All points meeting the specified significance threshold will be labelled by default with the values in the Labels columns. Users can select to only label the top significant points under **Plot Options** or only to label certain points through providing a tabular labels file. The labels file must contin a header row and have the labels in the first column. These labels must match the labels in the main input file. If no labels are desired specify 0 for "Only label top most signifcant". If a log fold change (lfc) threshold is specified, points that meet the significance threshold and lfc threshold will be coloured red if upregulated and blue if downregulated.

**Outputs**

A PDF containing a Volcano plot like below.

1:7b7303fa20e3

<tool id="volcanoplot" name="Volcano Plot" version="0.0.2">
    <description>create a volcano plot</description>
    <requirements>
        <requirement type="package" version="3.0.0">r-ggplot2</requirement>
        <requirement type="package" version="0.8.0">r-ggrepel</requirement>
        <requirement type="package" version="0.7.6">r-dplyr</requirement>

    -l $label_col
    -s $signif_thresh
    -x $lfc_thresh
    #if $labels.label_select == 'file':
        -f '$labels.label_file'
    #else if $labels.label_select == 'signif':
        #if $labels.top_num:
            -t $labels.top_num
        #end if
    #else
        -t 0
    #end if
    #if $plot_options.title:
        -T '$plot_options.title'
    #end if
    #if $plot_options.xlab:

        <param name="lfc_col" type="data_column" data_ref="input" label="Log Fold Change" />
        <param name="label_col" type="data_column" data_ref="input" label="Labels" />
        <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>
        </conditional>

    * 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.