annotate MUMmer/mummerplot_tool.xml @ 5:3aee0a8068b0 default tip

GNUplot with PNG support
author abossers
date Wed, 29 Oct 2014 15:40:42 +0100
parents f807110e7c80
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
1 <tool id="mummerplot_tool" name="MUMmer plot" version="1.0.1" force_history_refresh="true">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
2 <description>: Generate MUMmerplots from MUMmer match file</description>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
3 <command interpreter="bash">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
4 mummerplot_tool.sh
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
5 #if $img_format=="png":
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
6 png $input_match $out_png
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
7 #else:
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
8 postscript $input_match $out_postscript
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
9 #end if
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
10 $cmd_extra
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
11 </command>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
12 <inputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
13 <param name="input_match" type="data" format="tabular" label="MUMmer match (delta or tiling) file" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
14 <!-- <conditional name="outType"> -->
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
15 <param name="img_format" type="select" label="Output format" >
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
16 <option value="png" selected="true">PNG image</option>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
17 <option value="postscript">Postscript</option>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
18 </param>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
19 <!-- </conditional> -->
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
20 <param name="cmd_extra" type="text" size="40" value="" label="Extra cmd line options" help="See cmd line options below" />
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
21 </inputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
22 <outputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
23 <data name="out_png" format="png" label="MUMmerplot png">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
24 <filter>img_format=="png"</filter>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
25 </data>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
26 <data name="out_postscript" format="ps" label="MUMmerplot ps">
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
27 <filter>img_format=="postscript"</filter>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
28 </data>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
29 </outputs>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
30 <requirements>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
31 <!-- <requirement type="set_environment" version="3.23">MUMMER_PATH</requirement> -->
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
32 <requirement type="package" version="4.6.4">gnuplot</requirement>
3
f807110e7c80 Corrected tool dependencies
abossers
parents: 2
diff changeset
33 <requirement type="package" version="3.23">mummer</requirement>
2
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
34 </requirements>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
35 <tests>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
36 <test>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
37 </test>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
38 </tests>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
39 <help>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
40 |
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
41
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
42
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
43 **Reference**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
44 =============
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
45
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
46 - **MUMmerplot Galaxy tool wrapper: Alex Bossers, CVI of Wageningen UR, The Netherlands**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
47
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
48 - **MUMmerplot running on MUMmer-match file:** http://mummer.sourceforge.net/manual#mummerplot
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
49
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
50 - **MUMmer tutorials:** http://mummer.sourceforge.net/examples/
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
51
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
52 If you found these tools/wrappers usefull in your research, please acknowledge our work. If you improve
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
53 or modify the wrappers please add instead of substitute yourself into the acknowlegement section :)
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
54
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
55
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
56 **MUMmerplot**
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
57 ==============
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
58
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
59 | This plotting tool requires a MUMmer match file (either the delta file or the tiling result file)!
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
60 | MUMmerplot requires gnuplot (www.gnuplot.info) to be installed.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
61 |
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
62 | **The plotting has by default set the arguments --large and --png/--postscript to generate a fixed image instead of an interactive view!** Optional cmd line arguments can be used.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
63 |
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
64
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
65
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
66
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
67 Mummerplot is a script utility that takes output from *MUMmer, nucmer or promer* as DELTA file, or the
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
68 *show-tiling* result file, and converts it to a format suitable for plotting with gnuplot. The primary
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
69 plot type is an alignment dotplot where a sequence is laid out on each axis and a point is plotted at
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
70 every position where the two sequences show similarity. As an extension to this plot style, mummerplot
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
71 is also able to offset multiple 1-vs-1 dotplots to form a multiplot where multiple sequences can be
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
72 laid out on each axis. This plot style is especially handy for browsing an alignment of two contig
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
73 sets. Identity plots are also possible by coloring each data point with a color gradient representing
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
74 identity, or by collapsing the y-axis data onto a single line and then vertically offsetting the
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
75 data points by their identities. In addition to producing the plot data, mummerplot also generates a
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
76 gnuplot script that will be evaluated in order to generate the graph.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
77
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
78
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
79 The *match file* can either be a three column match list from mummer (either 3 or 4 column format),
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
80 the delta file from nucmer or promer, or the default output from show-tiling. mummerplot will
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
81 automatically detect the type of input file it is given, regardless of its file extension, or it
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
82 will fail if the input file is of an unrecognized type.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
83
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
84
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
85
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
86 Optional command line arguments
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
87 -------------------------------
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
88
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
89 --breaklen Highlight alignments with a breakpoint further than the given distance from the nearest sequence end
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
90 --nocolor Color plot lines with a percent similarity gradient or turn off all color (default color by match direction)
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
91 --coverage Generate a reference coverage plot, also known as a percent identity plot (default behavior for show-tiling input)
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
92 --depend Print dependency information and exit
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
93 --filter Only display alignments which represent the "best" one-to-one mapping of reference and query subsequences (requires delta formatted input)
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
94 --help Print help information and exit
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
95 --layout Layout a multiplot by ordering and orienting sequences such that the largest hits cluster near the main diagonal (requires delta formatted input)
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
96 --prefix *do not use in galaxy!* Set the output file prefix (default 'out')
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
97 --rv Reverse video, swap the foreground and background colors for x11 plots (requires x11 terminal)
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
98 --IdR Select a specific reference sequence for the x-axis
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
99 --IdQ Select a specific query sequence for the y-axis
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
100 --Rfile Generate a multiplot by using the order and length information contained in this file, either a FastA file of the desired reference sequences or a tab-delimited list of sequence IDs, lengths and orientations [ +-]
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
101 --Qfile Generate a multiplot by using the order and length information contained in this file, either a FastA file of the desired query sequences or a tab-delimited list of sequence IDs, lengths and orientations [ +-]
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
102 --size Set the output size to small, medium or large
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
103 --large **default enabled to generate highres image**. Other sizes no effect: --small --medium --large
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
104 --SNP Highlight SNP locations in the alignment
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
105 --terminal *do not use in galaxy* Set the output terminal to x11, postscript or png
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
106 --png **either png or postscript for fixed image**. Other interactive x11 not enabled
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
107 --postscript Alternate output format instead of png.
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
108 --xrange Set the x-range for the plot in the form "[min,max]"
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
109 --yrange Set the y-range for the plot in the form "[min,max]"
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
110 --version Display version information and exit
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
111
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
112
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
113 </help>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
114 </tool>
479eb076cd23 Add revised mummer toolshed files to testtoolshed
abossers
parents:
diff changeset
115