annotate MUMmer/mummer_tool.xml @ 0:61f30d177448 default tip

initial commit on Mummer toolsuite on toolshed
author eric
date Tue, 31 Mar 2015 14:19:49 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
1 <tool id="mummer_tool" name="MUMmer compare and plot" version="0.4.alx" force_history_refresh="True">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
2 <description>: Compare and plot genomes (Nucmer or Promer)</description>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
3 <command interpreter="bash">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
4 mummer_tool.sh
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
5 $input_ref $input_query
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
6 $out_delta $out_coords $out_png $out_log
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
7 $algorithm
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
8 $keep_delta $make_coords $keep_log $make_image
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
9 $cmd_extra
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
10 </command>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
11 <inputs>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
12 <param name="algorithm" type="select" format="text" value="nucmer" label="Algorithm" help="Nucmer dna or Promer protein (FASTA: protein. Dna is six frame translated)">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
13 <option value="nucmer">Nucmer DNA</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
14 <option value="promer">Promer</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
15 </param>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
16 <param name="input_ref" type="data" format="fasta" label="Reference sequence" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
17 <param name="input_query" type="data" format="fasta" label="Sequence query file"/>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
18 <param name="make_image" type="select" format="text" value="yes" label="Generate MUMmerplot" help="MUMmerplot will be run with default settings and --large --png as fixed image.">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
19 <option value="yes">Yes</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
20 <option value="no">No</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
21 </param>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
22 <param name="keep_delta" type="select" format="text" value="no" label="Keep delta file" help="i.e. for further processing">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
23 <option value="no">No</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
24 <option value="yes">Yes</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
25 </param>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
26 <param name="make_coords" type="select" format="text" value="yes" label="Make coords file" help="Uses the -r argument to sort lines by reference.">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
27 <option value="no">No</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
28 <option value="yes">Yes</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
29 </param>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
30 <param name="keep_log" type="select" format="text" value="no" label="Keep console log file" help="i.e. for debugging">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
31 <option value="no">No</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
32 <option value="yes">Yes</option>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
33 </param>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
34 <param name="cmd_extra" type="text" size="40" value="" label="Extra cmd line options" help="the --coords is run by default" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
35 </inputs>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
36 <outputs>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
37 <data name="out_coords" format="tabular" label="${algorithm.value_label} coords">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
38 <filter>make_coords=="yes"</filter>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
39 </data>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
40 <data name="out_delta" format="tabular" label="${algorithm.value_label} delta">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
41 <filter>keep_delta=="yes"</filter>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
42 </data>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
43 <data name="out_png" format="png" label="${algorithm.value_label} mummerplot">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
44 <filter>make_image=="yes"</filter>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
45 </data>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
46 <data name="out_log" format="tabular" label="Console log file">
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
47 <filter>keep_log=="yes"</filter>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
48 </data>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
49 </outputs>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
50 <requirements>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
51 <requirement type="package" version="4.6">gnuplot</requirement>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
52 <requirement type="package" version="3.23">mummer</requirement>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
53 </requirements>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
54 <tests>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
55 <test>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
56 <param name="algorithm" value="nucmer" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
57 <param name="input_ref" value="test.seq1.fasta"/>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
58 <param name="input_query" value="test.seq2.fasta"/>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
59 <param name="make_image" value="yes"/>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
60 <param name="keep_delta" value="no" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
61 <param name="make_coords" value="no" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
62 <param name="keep_log" value="yes" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
63
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
64 <output name="out_log" file="test.MUMmerplot.result.Nucmer_galaxy.log" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
65 <output name="out_png" file="test.MUMmerplot.result.Nucmer_galaxy.png" />
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
66 </test>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
67 </tests>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
68 <help>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
69 |
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
70
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
71
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
72 **Reference**
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
73 -------------
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
74
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
75 - **Nucmer Galaxy tool wrapper: Alex Bossers, CVI of Wageningen UR, The Netherlands.**
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
76
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
77 - **Nucmer or Promer of MUMmer suite:** v3.22 http://mummer.sourceforge.net/manual/
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
78
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
79 - **MUMmer tutorials:** http://mummer.sourceforge.net/examples/
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
80
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
81
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
82 If you found these tools/wrappers useful in your research, please acknowledge our work. If you improve
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
83 or modify the wrappers please add instead of substitute yourself into the acknowlegement section :)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
84
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
85
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
86 **Command line arguments**
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
87 --------------------------
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
88
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
89 --mum Use anchor matches that are unique in both the reference and query
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
90 --mumreference Use anchor matches that are unique in the reference but not necessarily unique in the query (default behavior)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
91 --maxmatch Use all anchor matches regardless of their uniqueness
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
92 --breaklen Distance an alignment extension will attempt to extend poor scoring regions before giving up (default 200)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
93 --mincluster Minimum cluster length (default 65)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
94 --delta Toggle the creation of the delta file. Setting --nodelta prevents the alignment extension step and only outputs the match clusters (default --delta)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
95 --depend Print the dependency information and exit
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
96 --diagfactor Maximum diagonal difference factor for clustering, i.e. diagonal difference / match separation (default 0.12)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
97 --extend Toggle the outward extension of alignments from their anchoring clusters. Setting --noextend will prevent alignment extensions but still align the DNA between clustered matches and create the .delta file (default --extend)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
98 --forward Align only the forward strands of each sequence
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
99 --maxgap Maximum gap between two adjacent matches in a cluster (default 90)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
100 --help Print the help information and exit
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
101 --minmatch Minimum length of an maximal exact match (default 20)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
102 --optimize Toggle alignment score optimization. Setting --nooptimize will prevent alignment score optimization and result in sometimes longer, but lower scoring alignments (default --optimize)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
103 --reverse Align only the reverse strand of the query sequence to the forward strand of the reference
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
104 --simplify Simplify alignments by removing shadowed clusters. Turn this option off (--nosimplify) if aligning a sequence to itself to look for repeats (default --simplify)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
105 --version Print the version information and exit
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
106 --coords **Automatically ON in galaxy wrapper!** It generates the .coords file using the 'show-coords' program with the -r option.
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
107 --prefix **Do NOT use in Galaxy wrapper!** Set the output file prefix (default out)
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
108
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
109 |
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
110 |
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
111
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
112 </help>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
113 </tool>
61f30d177448 initial commit on Mummer toolsuite on toolshed
eric
parents:
diff changeset
114