Skip to content

Commit fe0ad68

Browse files
committed
v5.7.0
Updated docs
1 parent 84b2fb1 commit fe0ad68

28 files changed

Lines changed: 474 additions & 416 deletions

docs/Details.html

Lines changed: 181 additions & 137 deletions
Large diffs are not rendered by default.

docs/Query.html

Lines changed: 11 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@
1313
<img src="./img/agcol_logo.gif" alt="AGCoL" style="width: 160px; border:1px solid black; background: white;"></a>
1414
<p class=sidetit>&nbsp;&nbsp;Queries</p>
1515
<p>
16-
<a href="#query">Query Setup</a>
16+
<a href="#instruct">&gt;Instructions</a>
17+
<a href="#query">&gt;Query Setup</a>
1718
<a href="#result">Result Panel</a>
18-
<a href="#rtab">Results</a>
19+
<a href="#but">&nbsp;&nbsp;&nbsp;Top buttons</a>
20+
<a href="#rtab">&gt;Results</a>
1921

2022
<p>&nbsp;
2123
<a href="#top">Go to top</a>
@@ -82,7 +84,7 @@
8284
<tr><td>&nbsp;
8385
<tr><td>&nbsp;
8486
<tr><td><ttl>Extra topic:</ttl>
85-
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#msp">3-chromosomes</a>
87+
<tr><td>&nbsp;&nbsp;&nbsp;<a href="Details.html#q3" class="ext" target="_blank">3-chr queries</a>
8688
</table>
8789
</table>
8890

@@ -182,9 +184,8 @@ <h3>Rules</h3>
182184
<p>
183185
<table><tr><td>
184186
Not numbered: The <ttx>Gene#</ttx> column will show the chromosome followed by ".~".
185-
<p>Numbered: These are numbered sequentially, where the counts start after the annotated gene numbers.
186-
For example, if the last Gene# for Chr03 is 5550 (e.g. 3.5550.), the first pseudo gene number will be 6000 and
187-
the column will show 3.6000.~.
187+
<p>Numbered: These are numbered sequentially, where the counts start after the annotated gene numbers and
188+
any already number pseudo's for the chromosome, hence, providing a unique <ttx>Gene#</ttx>.
188189

189190
<td><a href="img/query_pseudo.png"><img src="img/query_pseudo.png" alt="Pseudo genes" style="border: 1px solid black; width: 350px"></a>
190191
</table>
@@ -770,14 +771,14 @@ <h4>4.2 MSA...</h4>
770771
<br>&rarr; All executables were removed that did not seem necessary. However, I may have removed
771772
one(s) that are used in certain unusual situations when <tt>--auto</tt> is used. Try again with <tt>--auto</tt> unchecked.
772773
<br>&rarr; On Mac, if you are using MAFFT <tt>--auto</tt>, you may get a "Cannot be verified" for <tt>dndpre</tt>.
773-
See <a href="TroubleShoot.html#macos">MacOS and external programs</a> to fix this.
774+
See <a href="TroubleShoot.html#macos" class="ext" target="_blank">MacOS and external programs</a> to fix this.
774775

775776
<a id="view2D"></a>
776777
<h4>4.3 View 2D</h4>
777778

778779

779780
<a href="img/query_2D.png"><img src="img/query_2D.png" alt="query 2D" style="border: 1px solid black; width: 400px"></a>
780-
<p>This displays the <ttl>2D</ttl> view for the selected entry (see <a href="#msp">3-chromosomes</a>).
781+
<p>This displays the <ttl>2D</ttl> view for the selected entry.
781782
The region displayed can be specified by the drop-down beside the <ttl>View 2D</ttl> button, as follows:
782783

783784
<a id="group"></a>
@@ -833,6 +834,8 @@ <h4>4.3 View 2D</h4>
833834
can be used with these rows.
834835
<p><a href="img/query_columns_mult.png"><img src="img/query_columns_mult.png" alt="query multi columns" style="border: 1px solid black; width: 280px"></a>
835836

837+
<p>&nbsp;<p>It is possible to select two rows for a 3-chromosome <ttb>2D</ttb>,
838+
see <a href="Details.html#q3" class="ext" target="_blank">3-chr queries</a>.
836839
<td><a href="img/query_synteny.png"><img src="img/query_synteny.png" alt="query synteny" style="border: 1px solid black; width: 450px"></a>
837840
</table>
838841

@@ -1060,7 +1063,6 @@ <h4>4.6 Search...</h4>
10601063
<a id="rtab"></a>
10611064
<h2><small>&gt;</small> Results</h2>
10621065

1063-
10641066
<a href="img/query_result_tab.png"><img src="img/query_result_tab.png" alt="query results tab" style="border: 1px solid black; width: 600px"></a>
10651067
<p>All query results are listed under the <ttb>&gt; Results</ttb> tab on the left.
10661068
Clicking this tab shows the table of queries illustrated above.
@@ -1069,33 +1071,6 @@ <h2><small>&gt;</small> Results</h2>
10691071
<p>The only way to remove query results from the left tab is by selecting them in this table followed
10701072
by <ttl>Remove Selected</ttl>, remove all with <ttl>Remove All</ttl>.
10711073

1072-
<!---------------------------------------------------------------->
1073-
<a id="msp"></a>
1074-
<h3>3-chromosomes</h3>
1075-
1076-
&rarr; <a href="#report">Report</a> is only way to view more than two species in a query row (described
1077-
immediately above).
1078-
<br>&rarr;As shown here, it is possible to bring up the 2D display with 3 chromosomes from the query table.
1079-
<p>
1080-
<table>
1081-
<tr>
1082-
<td style="vertical-align: text-top;">
1083-
Select two rows with the following requirements:
1084-
(1) Each row must have two genes.
1085-
(2) There must be a shared gene.
1086-
1087-
<p><small>Different species</small>
1088-
<br><a href="img/query_2D_2row.png"><img src="img/query_2D_2row.png" alt="Select 2 rows" style="border: 1px solid black; width: 280px"></a>
1089-
1090-
<p><small>Same species</small>
1091-
<br><a href="img/query_2D_2rowb.png"><img src="img/query_2D_2rowb.png" alt="Select 2 rows" style="border: 1px solid black; width: 240px"></a>
1092-
<p>Select <ttl>View 2D</ttl> with either the <ttx>Region</ttx> and <ttx>Collinear</ttx> options. The
1093-
image on the right used the <ttx>Collinear</ttx> options.
1094-
<p>&nbsp;<p>
1095-
<a href="Details.html#con" class="ext" target="_blank">2D Highlight Conserved Genes</a>
1096-
shows how to highlight shared or unique genes in the 2D display of 3 chromosomes.
1097-
<td><a href="img/2d-3d-coset.png"><img src="img/2d-3chr-coset.png" alt="report A.thal ref" style="border: 1px solid black; width: 480px"></a>
1098-
</table>
10991074

11001075
<!---- END BODY -->
11011076
<table style="width: 95%"><tr><td style="text-align: left">

docs/Release.html

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,26 @@ <h3>Summary of recent major releases</h3>
6767
<tr><td><a href="#v540">v5.4.0</a><td>(6-Apr-23)<td>Improved <ttx>Cluster Hit</ttx> algorithm <ttx>Algo1</ttx> for the detection of gene homology.
6868
</table>
6969

70+
<a id="v570"></a>
71+
<h3>Release: v5.7.0 (20-July-25)</h3>
72+
Small improvements.
73+
<ul>
74+
<li><ttb>Manager</ttb>: (1) For the <ttx>Selected</ttx> on the <ttb>Manager</ttb>, the <ttx>#Annotated</ttx> was
75+
wrong if pseudo genes were assigned; it has been changed to show <ttx>Exons</ttx> instead. (2) The <ttb>View</ttb> now has a <ttx>Gap</ttx> column (if any exists)
76+
and a <ttx>Totals</ttx> row.
77+
<li><ttb>2D</ttb>: The 3-track g2x2 (shared) and g2x1 (unique) was confusing because it only worked on visible hits;
78+
see <a href="Details.html#2dg2" class="ext" target="_blank">3-chr conserved</a> for the way it works now.
79+
<li>Tiny changes:
80+
<ul>
81+
<li><ttb>A&S</ttb> <ttl>Number Pseudo</ttl>: This option could duplicate pseudo <ttx>Gene#</ttx> for different synteny pairs;
82+
this worked but may be confusing when querying &gt;2 synteny pairs. This has been corrected. An existing SyMAP database can be updated running
83+
<tt>symap -pseudo</tt>.
84+
<li><ttb>2D</ttb>: Slight change in hit-wire information and popup (see <a href="UserGuide.html#info" class="ext" target="_blank">Hit popup</a>).
85+
<li><ttb>Queries</ttb>: Pseudo message in <ttx>Instructions</ttx> has been redone.
86+
<li>If a <ttl>Display Name</ttl> is re-used, it provides more information about the duplicate.
87+
</ul>
88+
</ul>
89+
7090
<a id="v569"></a>
7191
<h3>Release: v5.6.9 (19-June-25)</h3>
7292

@@ -142,7 +162,6 @@ <h3>Release: v5.6.7 (22-May-25)</h3>
142162
<p>
143163
<li><small>Developers: Rename synteny/SyGraph to Merge and move merge routines to it; add orient.
144164
Any java file I looked at, I took out old CASddd comments.</small>
145-
</small>
146165
</ul>
147166

148167

@@ -255,7 +274,7 @@ <h3>Release: v5.6.3 (5-Apr-25)</h3>
255274
<li><ttl>Queries</ttl>
256275
<ul>
257276
<li>Bug fix on Linux: crashed on searching for a given collinear set.
258-
<li><ttl>MSA</ttl>: See <a href="Query.html#msaAlign" ext="class" target="_blank">MSA</a>.
277+
<li><ttl>MSA</ttl>: See <a href="Query.html#msaAlign" class="ext" target="_blank">MSA</a>.
259278
<ul>
260279
<li>MUSCLE is very slow, so MAFFT has been added which is many times faster.
261280
<li>Bug fix: negative strand hits were not reversed complemented.
@@ -269,12 +288,12 @@ <h3>Release: v5.6.3 (5-Apr-25)</h3>
269288
The results are sorted according to the lower table of information. The results are
270289
in a split pane.
271290
</ul>
272-
<li><ttl>Cluster genes</ttl>: See <a href="Query.html#clhit" ext="class" target="_blank">Cluster genes</a>.
291+
<li><ttl>Cluster genes</ttl>: See <a href="Query.html#clhit" class="ext" target="_blank">Cluster genes</a>.
273292
<ul>
274293
<li>A new filter called <ttl>Cluster hits</ttl> has replaced <ttl>PgeneF</ttl> (which can still
275294
be run using <tt>viewSymap -g</tt>).
276295
</ul>
277-
<li><ttl>Gene Pair Report...</ttl> See <a href="Query.html#report" ext="class" target="_blank">Report</a>.
296+
<li><ttl>Gene Pair Report...</ttl> See <a href="Query.html#report" class="ext" target="_blank">Report</a>.
278297
<ul>
279298
<li><ttl>Multi-Hit Gene Report</ttl>:
280299
(1) This was confusing because groups can be created from non-gene hits,
@@ -291,7 +310,8 @@ <h3>Release: v5.6.3 (5-Apr-25)</h3>
291310
</ul>
292311
<li>The <ttl>Grp#</ttl> and <ttl>Grp Size</ttl> have been merged into one column:
293312
<tt>Size-Grp#</tt>.
294-
<li>Other:<small>
313+
<li>Other:
314+
<small>
295315
<ul>
296316
<li>Rewrote the Instruction page since its HTML was obsolete in Java20.
297317
Formatted the table Statistics better. If a chromosome was selected, the statistics did not show the Groups counts; it does now.
@@ -341,7 +361,7 @@ <h3>Release: v5.6.2 (24-Feb-25)</h3>
341361
<ul>
342362
<li>It will display <ttl>View 2D</ttl> with 3-tracks (chromosomes) if two rows are selected which have a common reference gene,
343363
and has 'both' genes in both rows. This works with the <ttx>Region</ttx> or <ttx>Collinear Set</ttx> options.
344-
See <a href="Query.html#msp" class="ext" target="_blank">3-chromosome 2D</a>.
364+
See <a href="Query.html#q3" class="ext" target="_blank">3-chromosome 2D</a>.
345365
<li>A new <ttx>Gene#</ttx> checkbox for <ttl>View 2D</ttl> which shows the <ttx>Gene#</ttx> instead of the <ttx>Annotation</ttx>.
346366
</ul>
347367
<li><ttl>Report...</ttl>:

docs/SystemGuide.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,11 @@ <h3>Overview</h3>
129129
SyMAP is a system for computing, displaying, and analyzing syntenic alignments between
130130
divergent eukaryotic genomes. It is designed for the comparison of a few genomes at a time
131131
(i.e. 2-4) where synteny is computed between each pair.
132-
Its features include the following:
132+
133133
<table class="tx">
134134
<tr><td>
135+
Its features include the following:
136+
<p>
135137
<ul>
136138
<li><i>Compute</i>
137139
<ul>
@@ -145,11 +147,13 @@ <h3>Overview</h3>
145147
<li>Complete queries on annotation, collinear genes, multi-hit genes, etc.
146148
</ul>
147149
</ul>
148-
<td><a href="img/symapPlants.png"><img src="img/symapPlants.png" alt="viewPlants"
149-
style="width:220px;border: 1px solid black;"></a>
150+
<td>
151+
<center><small>Click an image to see the closeup.</small></center>
152+
<br><a href="img/symapPlants.png"><img src="img/symapPlants.png" alt="viewPlants"
153+
style="width:390px;border: 1px solid black;"></a>
150154
</table>
151155

152-
<center><small>Click an image to see the closeup.</small></center>
156+
153157
<table class="tx">
154158
<tr>
155159
<td><a href="img/dotplot-3g.png"><img src="img/dotplot-3g.png" alt="dotplot-3-genome"

0 commit comments

Comments
 (0)