Skip to content

Commit db9231e

Browse files
committed
v5.8.6
Update xToSymap. Add new Queries Export option.
1 parent 8388339 commit db9231e

48 files changed

Lines changed: 6046 additions & 4806 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/Query.html

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252

5353
<!-- **************** bulk of page ********************* -->
5454
<div class="main">
55-
55+
<p>&nbsp;
5656
<table>
5757
<tr>
5858
<td style="white-space: nowrap; vertical-align: text-top;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -77,20 +77,20 @@
7777
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#pairCol">Pair</a>, <a href="#singleCol">Single</a>, <a href="#save">Auto-save</a>&nbsp;&nbsp;&nbsp;&nbsp;
7878
<tr><td><a href="#stat">Statistics</a>
7979
<tr><td><a href="#but">Top buttons</a>
80-
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#msaAlign">MSA</a>, <a href="#view2D">View 2D</a>, <a href="#report">Report</a>, <a href="#search">Search</a>,...
80+
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#showRow">Show</a>, <a href="#msaAlign">MSA...</a>, <a href="#view2D">View 2D</a>
81+
<tr><td>&nbsp;&nbsp;&nbsp;<a href="#export">Export...</a>, <a href="#report">Report...</a>, <a href="#search">Search</a>,...
8182
</table>
8283
<td style="white-space: nowrap; vertical-align: text-top;">
8384
<table>
8485
<tr><td><a href="#rtab"><u><small>&gt;</small> Results</u></a>
8586
<tr><td>&nbsp;
86-
<tr><td><span class="ttb">Extra topics:</span>
87+
<tr><td><span class="ttl">Extra topics:</span>
8788
<tr><td>&nbsp;&nbsp;&nbsp;<a href="UserGuide.html#self" target="_blank" class="ext">Self-synteny</a>
8889
<tr><td>&nbsp;&nbsp;&nbsp;<a href="Details.html#q3" class="ext" target="_blank">3-chr queries</a>
90+
<tr><td>&nbsp;&nbsp;&nbsp;<a href="UserGuide.html#term" class="ext" target="_blank">Terminology</a>
8991
</table>
9092
</table>
9193

92-
See <a href="./UserGuide.html#term" class="ext" target="_blank">Terminology</a> in the User Guide.
93-
9494
<!-- ************************************************************************ -->
9595
<hr>
9696
To open the query interface, first select two or more projects in the
@@ -239,7 +239,12 @@ <h3>2. General</h3>
239239

240240
<p><span class="ttb">Annotation Description</span>
241241
<ul><li>Enter a substring: the entire <span class="ttx">All_Anno</span> attributes column (see <a href="#geneCol">Columns</a>)
242-
will be searched for the substring.
242+
will be searched for the substring, as follows.
243+
<ul>
244+
<li><span class="ttl">Any</span>:&nbsp;&nbsp; A match anywhere in <span class="ttx">All_Anno</span>.
245+
<li><span class="ttl">Exact</span>: For each 'keyword=value' pair, the value will be checked for an exact match.
246+
<li><span class="ttl">Start</span>:&nbsp; For each 'keyword=value' pair, the value will be checked for a match at the beginning.
247+
</ul>
243248
<li>By default, either end of the hit can have the annotation.
244249
<br>To restrict the search to one end, see <u>Unselect species</u> below.
245250
<li>If there are no additional filters, <i>this is slow</i> on large databases.
@@ -877,6 +882,7 @@ <h4>4.2 MSA...</h4>
877882
<br>&rarr; On Mac, if you are using MAFFT <span class="ttt">--auto</span>, you may get a "Cannot be verified" for <span class="ttt">dndpre</span>.
878883
See <a href="TroubleShoot.html#macos" class="ext" target="_blank">MacOS and external programs</a> to fix this.
879884

885+
<p>&nbsp;
880886
<a id="view2D"></a>
881887
<h4>4.3 View 2D</h4>
882888

@@ -943,28 +949,36 @@ <h4>4.3 View 2D</h4>
943949
<td><a href="img/query_synteny.png"><img src="img/query_synteny.png" alt="query synteny" style="border: 1px solid black; width: 450px"></a>
944950
</table>
945951

952+
<!-- ********************* Export ******************************************** -->
953+
<p>&nbsp;
946954
<a id="export"></a>
947955
<h4>4.4 Export...</h4>
948956
One or more rows can be selected for the following exports; or if no rows are selected, the entire table is exported.
949957

950958
<table class="tx">
951959
<tr><td>
952-
<p><span class="ttb">CSV</span>:
960+
<b>Table row and columns</b>
961+
<p class="hanging-indent"><span class="ttb">CSV</span>:
953962
Export the rows using the selected set of columns to a CSV format suitable for import into Excel.
954-
<p><span class="ttb">HTML</span>:
963+
<p class="hanging-indent"><span class="ttb">HTML</span>:
955964
Export the rows using the selected set of columns to a HTML format suitable for viewing on the web
956965
(e.g. <a href="./img/query_export.html" class="ext" target="_blank">Example</a>).
957-
<p>The <span class="ttb">Include Row column</span> option is available because this column is alway present, but
958-
it may be desirable to exclude it in the output.
959-
<p>
960-
<span class="ttb">FASTA</span>: (Pairs Only) For each row, the two hit sequences from the <span class="ttx">Hstart</span> to <span class="ttx">Hend</span>
961-
are written to file. NOTE: this is a very slow function and takes minutes if many rows are selected.
962-
963-
<td>
964-
<a href="img/query_export.png"><img src="img/query_export.png" alt="result export" style="border: 1px solid black; width: 260px"></a>
966+
<p class="hanging-indent"><span class="ttb">Include Row column</span>: This option is available because column
967+
<span class="ttt">Row</span> is alway present, but it may be desirable to exclude it in the output.
968+
969+
<p><b>Table FASTA</b>
970+
<p class="hanging-indent"><span class="ttb">All pair hit sequences</span>: (Pairs Only)
971+
For each row, the two hit sequences from the <span class="ttx">Hstart</span> to <span class="ttx">Hend</span>
972+
are written to file.
973+
<p class="hanging-indent"><span class="ttb">Unique spliced transcripts</span>:
974+
For each row, output the spliced transcripts.
975+
This is very slow to execute! For example, it took 1m15s for 500 rows.
976+
977+
<td><a href="img/query_export.png"><img src="img/query_export.png" alt="result export" style="border: 1px solid black; width: 260px"></a>
965978
</table>
966979
<!-- ************************************************************************ -->
967980
<!-- ********************* REPORT ******************************************** -->
981+
<p>&nbsp;
968982
<a id="report"></a>
969983
<h4>4.5 Report...</h4>
970984

@@ -979,14 +993,17 @@ <h4>4.5 Report...</h4>
979993
<p>
980994
<ul>
981995
<li>The report is on the genes in the query table; <i>hits without paired genes are ignored</i>.
996+
<p>
982997
<li>Unless the query is for <span class="ttb">Collinear</span>, <span class="ttb">Multi-hit</span> or <span class="ttb">Cluster genes</span>, a <span class="ttb">Gene</span>
983998
report will be produced.
984-
<li>This is most relevant when used with &gt;2 species. <i><u>It has not been tested for &gt;4 species.</u></i>
985-
<li><span class="ttb">Gene</span>, <span class="ttb">Collinear</span> and <span class="ttb">Multi-hit genes</span> produce a reference-based report whereas
986-
the <span class="ttb">Cluster genes</span> does not; however <span class="ttb">Cluster genes</span> shares most of the same options.
999+
<p><li>This is most relevant when used with &gt;2 species. <i>It has not been tested for &gt;4 species.</i>
1000+
1001+
<p><li><span class="ttb">Gene</span>, <span class="ttb">Collinear</span> and <span class="ttb">Multi-hit genes</span>
1002+
produce a <u>reference-based</u> report whereas the <span class="ttb">Cluster genes</span> does not;
1003+
however <span class="ttb">Cluster genes</span> shares most of the same options.
9871004
</ul>
9881005
<a id="rint"></a>
989-
<h4>Reference-based interface</h4>
1006+
<h4>Interface</h4>
9901007
<p>The menu on the lower-right shows the options that will always exist.
9911008
There may be additional options in between the middle lines,
9921009
depending on the condition used to create the table, as discussed below.
@@ -1032,6 +1049,7 @@ <h4>Reference-based interface</h4>
10321049
</ul>
10331050
The following discussion will all apply to results from 3 or 4 species.
10341051
<!-- ************************************ -->
1052+
10351053
<a id="rgene"></a>
10361054
<h4>Gene Report</h4>
10371055

@@ -1109,7 +1127,7 @@ <h4>Multi-hit gene report</h4>
11091127

11101128
<!-- Cluster Group -->
11111129
<p><a id="rclust"></a>
1112-
<h4>4.5.5 Cluster gene report</h4>
1130+
<h4>Cluster gene report</h4>
11131131

11141132
<table class="tx">
11151133
<tr><td>
@@ -1143,6 +1161,7 @@ <h4>4.5.5 Cluster gene report</h4>
11431161
<img src="img/query_report_clust.png" alt="report cluster" style="border: 1px solid black; width: 700px"></a>
11441162

11451163
<!-- ************************************************************************ -->
1164+
<p>&nbsp;
11461165
<a id="search"></a>
11471166
<h4>4.6 Search...</h4>
11481167

@@ -1174,8 +1193,9 @@ <h4>4.6 Search...</h4>
11741193
<span class="ttb">Restart</span>: Clear internal parameters so the next <span class="ttb">Next</span> restarts the search from the first row.
11751194
<br>Changing any value on the panel also restarts the search.
11761195
<p>
1177-
<hr>
1196+
11781197
<!-- ************************************************************************ -->
1198+
<hr>
11791199
<a id="rtab"></a>
11801200
<h2><span class="small">&gt;</span> Results</h2>
11811201

docs/Release.html

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,53 @@ <h3>Summary of recent major releases</h3>
5454
<tr><td><a href="#v540">v5.4.0</a><td>(06-Apr-23)<td>Improved <span class="ttx">Cluster Hit</span> algorithm <span class="ttx">Algo1</span> for the detection of gene homology.
5555
</table>
5656

57+
<a id="v586"></a>
58+
<h3>Release: v5.8.6 (15-July-2026)</h3>
59+
Changed to <span class="ttp">symap</span> and <span class="ttp">xToSymap</span> (including <span class="ttt">scripts/ConvertNCBI.java</span>
60+
and <span class="ttt">scripts/ConvertEns.java</span>).
61+
<p>
62+
<ul>
63+
<li><span class="ttp">xToSymap</span>:
64+
<ul>
65+
<li>Instead of using the first mRNA per gene, the following is done:
66+
<br>NCBI: use the longest mRNA.
67+
<br>Ensembl: use the mRNA with 'tag=Ensembl_canonical'; if none exist,
68+
use the longest mRNA.
69+
<li>The GFF output includes the CDS coordinates.
70+
<li><span class="ttl">All Seqs</span> option was added, which converts all sequences for SyMAP input.
71+
<br><span class="ttl">Include Protein-ID</span> option was removed.
72+
<li>Small things:
73+
<ul>
74+
<li>Instead of using the <span class="ttt">seqid</span> prefix 'Unk' for unknown sequences, the prefix 'Seq' is used.
75+
<li>NCBI: If a gff file has the scaffold NW_ prefix but the line contains 'chromosome',
76+
keep it a scaffold (it was tagging it a chromosome).
77+
<li>Ensembl: If a gene has no description, it will be given one of "uncharacterized protein".
78+
</ul>
79+
<li><span class="ttb">Summary</span>: Has various changes to improve the output.
80+
</ul>
81+
<p>
82+
<li><span class="ttp">Load Annotation</span>: If symap is started with the '-cds' flag, the CDS coordinates
83+
are loaded instead of the Exons. The only place this is obvious is on the
84+
<span class="ttp">Manager</span> and <span class="ttp">View</span>
85+
option for the species project; everywhere else will still say 'Exon'.
86+
<p>
87+
<li><span class="ttp">Queries</span>:
88+
<ul>
89+
<li>New options for <span class="ttx">Exact</span> and <span class="ttx">Start</span> for annotation.
90+
<li><span class="ttl">Export</span>: new option <span class="ttx">Unique splice genes</span>
91+
to export FASTA spliced genes, which also works for singles. If the annotation was loaded with
92+
<span class="ttp">symap</span> using the -cds flag,
93+
the output will be the spliced CDSs, else it will be the spliced exons.
94+
<li>Bug fix: (1) The <span class="ttl">Export</span> did not work for selected rows.
95+
(2) <span class="ttl">Show</span>
96+
crashed if using the <span class="ttl">Single</span> option.
97+
</ul>
98+
<p>
99+
<li><small>Developers: (1) ConvertNCBI and ConvertEnsembl were redesigned into classes. (2)
100+
Schema projects.types was changed from an enum to short string with types ncbi, ens, other.
101+
</small>
102+
</ul>
103+
<!-- ==================== -->
57104
<a id="v585"></a>
58105
<h3>Release: v5.8.5 (1-June-2026)</h3>
59106
More changes to the <span class="ttp">Linear</span> and <span class="ttp">Circle</span> control of displays.
@@ -816,7 +863,7 @@ <h3>Release: v5.6.1 (12-Feb-25)</h3>
816863
<ul>
817864
<li>The default is to surpress output to the terminal and <span class="ttt">logs/{proj-to-proj}/symap.log</span> except final summaries.
818865
To show the verbose output, use <span class="ttx">./symap -v</span> or use the parameters
819-
<a href="SystemHelp" class="ext" target="_blank">Verbose</a> checkbox.
866+
<a href="SystemHelp.html#cpu" class="ext" target="_blank">Verbose</a> checkbox.
820867
See <a href="Demo.html#slog" class="ext" target="_blank">Demo examples</a>.
821868
<li>Status lines, which repeatedly use the same line, are written to stderr instead of stdout.
822869
<li>The <span class="ttx">symap</span> or <span class="ttx">viewSymap</span> flag to show settings for the important MySQL variables is now "-sql".

docs/SystemHelp.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,6 @@ <h3>2.a Parameter panel</h3>
319319
<p><i>Make sure these two parameters are correct before running the alignment</i>: <span class="ttl">Minimum length</span>, <span class="ttl">Sequence files</span>.
320320
These are described in <a href="#project">Load project</a>.
321321

322-
<p>&nbsp;
323322
<p><span class="ttl">Sequence</span> and <span class="ttl">Anno</span> (annotation) <span class="ttl">files</span>:
324323
<br>If the files are put in the default locations, nothing needs to be entered for them.
325324
Default locations:
@@ -329,6 +328,10 @@ <h3>2.a Parameter panel</h3>
329328
</pre>
330329
See <a href="./input/index.html" class="ext" target="_blank">input</a> for a description of the input files.
331330
</table>
331+
<p>&nbsp;<p>
332+
Note: as of v5.8.6, the <span class="ttp">xToSymap</span> conversion programs include CDS coordinates
333+
in the converted .gff files. If you start symap with the '-cds' option, the CDS coordinates will be loaded instead of
334+
the exons; the only evidence that they were used is on the project's <a href="input/img/viewB.png">View</a> panel.
332335

333336
<td><a href="img/parameters1.png">
334337
<img src="img/parameters1.png" alt="parameters1" style="border: 1px solid black; width: 400px"></a>

docs/UserGuide.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1821,7 +1821,8 @@ <h3>Export (download data)</h3>
18211821
<ul>
18221822
<li><a href="Query.html#export" class="ext" target="_blank">Query Export</a>:
18231823
The results of a query are shown in a table,
1824-
which can be exported as a CSV or HTML file. The hit sequences can be exported in FASTA format.
1824+
which can be exported as a CSV or HTML file. Additionally,
1825+
the hit sequences or unique spliced genes from the genes i can be exported in FASTA format.
18251826
<p>
18261827
<li><a href="Query.html#export" class="ext" target="_blank">Gene Report</a>:
18271828
A report that combines rows of a query can be created and exported in HTML or TSV format.

0 commit comments

Comments
 (0)