annotate volcanoplot.xml @ 4:73b8cb5bddcd draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit e8c104fae4904d9c3c35834ac37ee17cf8e49bb9
author iuc
date Sun, 04 Aug 2019 10:53:30 -0400
parents 6d532d760950
children 44608d0193ed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
1 <tool id="volcanoplot" name="Volcano Plot" version="0.0.3">
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
2 <description>create a volcano plot</description>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
3 <requirements>
3
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
4 <requirement type="package" version="3.1.0">r-ggplot2</requirement>
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
5 <requirement type="package" version="0.8.0">r-ggrepel</requirement>
3
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
6 <requirement type="package" version="0.7.8">r-dplyr</requirement>
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
7 <requirement type="package" version="1.20.2">r-getopt</requirement>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
8 </requirements>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
9 <version_command><![CDATA[
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
10 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: ")", getopt version" $(R --vanilla --slave -e "library(getopt); cat(sessionInfo()\$otherPkgs\$getopt\$Version)" 2> /dev/null | grep -v -i "WARNING: ")
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
11 ]]></version_command>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
12 <command detect_errors="exit_code"><![CDATA[
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
13
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
14 Rscript '${__tool_directory__}/volcanoplot.R'
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
15
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
16 -i '$input'
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
17 -a $fdr_col
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
18 -p $pval_col
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
19 -c $lfc_col
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
20 -l $label_col
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
21 -s $signif_thresh
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
22 -x $lfc_thresh
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
23 #if $labels.label_select == 'file':
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
24 -f '$labels.label_file'
1
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
25 #else if $labels.label_select == 'signif':
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
26 #if $labels.top_num:
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
27 -t $labels.top_num
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
28 #end if
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
29 #else
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
30 -t 0
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
31 #end if
3
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
32 #if $plot_options.boxes:
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
33 -b
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
34 #end if
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
35 #if $plot_options.title:
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
36 -T '$plot_options.title'
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
37 #end if
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
38 #if $plot_options.xlab:
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
39 -X '$plot_options.xlab'
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
40 #end if
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
41 #if $plot_options.ylab:
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
42 -Y '$plot_options.ylab'
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
43 #end if
3
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
44 #if $plot_options.xmin:
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
45 -m '$plot_options.xmin'
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
46 #end if
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
47 #if $plot_options.xmax:
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
48 -M '$plot_options.xmax'
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
49 #end if
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
50 #if $plot_options.ymax:
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
51 -W '$plot_options.ymax'
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
52 #end if
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
53 #if $plot_options.legend:
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
54 -L '$plot_options.legend'
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
55 #end if
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
56 -z '$plot_options.legend_labs'
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
57
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
58 ]]></command>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
59 <inputs>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
60 <param name="input" type="data" format="tabular" label="Specify an input file" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
61 <param name="fdr_col" type="data_column" data_ref="input" label="FDR (adjusted P value)" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
62 <param name="pval_col" type="data_column" data_ref="input" label="P value (raw)" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
63 <param name="lfc_col" type="data_column" data_ref="input" label="Log Fold Change" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
64 <param name="label_col" type="data_column" data_ref="input" label="Labels" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
65 <param name="signif_thresh" type="float" max="1" value="0.05" label="Significance threshold" help="Default: 0.05"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
66 <param name="lfc_thresh" type="float" value="0" label="LogFC threshold to colour" help="Default: 0"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
67 <conditional name="labels">
1
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
68 <param name="label_select" type="select" label="Points to label" help="Select to label significant points or input labels from file. Default: None">
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
69 <option value="none" selected="True">None</option>
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
70 <option value="signif">Significant</option>
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
71 <option value="file">Input from file</option>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
72 </param>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
73 <when value="signif">
1
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
74 <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."/>
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
75 </when>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
76 <when value="file">
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
77 <param name="label_file" type="data" format="tabular" label="File of labels"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
78 </when>
4
73b8cb5bddcd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit e8c104fae4904d9c3c35834ac37ee17cf8e49bb9
iuc
parents: 3
diff changeset
79 <when value="none" />
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
80 </conditional>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
81 <section name="plot_options" expanded="false" title="Plot Options">
3
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
82 <param name="boxes" type="boolean" truevalue="True" falsevalue="False" checked="True" label="Label Boxes" help="If this is set to Yes, the labels for the points will be in boxes. Default: Yes"/>
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
83 <param name="title" type="text" optional="True" label="Plot title"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
84 <param name="xlab" type="text" optional="True" label="Label for x axis"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
85 <param name="ylab" type="text" optional="True" label="Label for y axis"/>
3
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
86 <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."/>
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
87 <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."/>
6d532d760950 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 16205b1cd782c5a4f7c08af7d4ee50dc5903418b
iuc
parents: 1
diff changeset
88 <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."/>
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
89 <param name="legend" type="text" optional="True" label="Label for Legend Title"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
90 <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"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
91 </section>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
92 </inputs>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
93 <outputs>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
94 <data name="plot" format="pdf" from_work_dir="out.pdf" label="Volcano plot on ${on_string}"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
95 </outputs>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
96 <tests>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
97 <test>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
98 <!-- Ensure default output works -->
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
99 <param name="input" ftype="tabular" value="input.tab"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
100 <param name="fdr_col" value="4" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
101 <param name="pval_col" value="3" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
102 <param name="lfc_col" value="2" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
103 <param name="label_col" value="1" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
104 <param name="lfc_thresh" value="0" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
105 <output name="plot" value= "out.pdf" compare="sim_size" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
106 </test>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
107 <test>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
108 <!-- Ensure input labels and plot options work -->
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
109 <param name="input" ftype="tabular" value="input.tab"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
110 <param name="fdr_col" value="4" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
111 <param name="pval_col" value="3" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
112 <param name="lfc_col" value="2" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
113 <param name="label_col" value="1" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
114 <param name="lfc_thresh" value="0" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
115 <param name="label_select" value="file"/>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
116 <param name="label_file" ftype="tabular" value="labels.tab" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
117 <output name="plot" value= "out2.pdf" compare="sim_size" />
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
118 </test>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
119 </tests>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
120 <help><![CDATA[
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
121 .. class:: infomark
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
122
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
123 **What it does**
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
124
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
125 This tool creates a Volcano plot using ggplot2. Points can be labelled via ggrepel.
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
126
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
127 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.
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
128
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
129 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).
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
130
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
131 Source: Wikipedia
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
132
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
133 -----
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
134
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
135 **Inputs**
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
136
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
137 A tabular file with a header row containing the columns below (additional columns may be present):
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
138
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
139 * P value
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
140 * FDR / adjusted P value
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
141 * Log fold change
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
142 * Labels (e.g. Gene symbols or IDs)
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
143
1
7b7303fa20e3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit c2b155f1fd4470ddecb5bd1c6e2c54dd46bfeaed
iuc
parents: 0
diff changeset
144 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.
0
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
145
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
146 **Outputs**
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
147
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
148 A PDF containing a Volcano plot like below.
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
149
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
150 .. image:: $PATH_TO_IMAGES/volcano_plot.png
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
151
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
152 .. _Volcano plot: https://en.wikipedia.org/wiki/Volcano_plot_(statistics)
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
153
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
154 ]]></help>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
155 <citations>
59ebf2c42c0e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit 7cc1a05f2868f270bf5bdbbd4820ef6f69c9fc8d
iuc
parents:
diff changeset
156 </citations>
4
73b8cb5bddcd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/volcanoplot commit e8c104fae4904d9c3c35834ac37ee17cf8e49bb9
iuc
parents: 3
diff changeset
157 </tool>