annotate MUMmer/mummerplot_tool.xml @ 0:6753195df9e0 default tip

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