JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / varna.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *  
13  * Jalview is distributed in the hope that it will be useful, but 
14  * WITHOUT ANY WARRANTY; without even the implied warranty 
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
16  * PURPOSE.  See the GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
20  * The Jalview Authors are detailed in the 'AUTHORS' file.
21  -->
22 <head>
23 <title>The VARNA RNA Viewer</title>
24 </head>
25 <body>
26   <p>
27     <strong>The VARNA RNA Viewer</strong>
28   </p>
29   <p>
30     <a href="http://varna.lri.fr">VARNA</a> was integrated into Jalview
31     2.8 to allow interactive viewing of RNA secondary structure
32     annotation. It is opened by selecting the <strong>&quot;Structure&#8594;View
33       Structure:&quot;</strong> option in the <a href="../menus/popupMenu.html">sequence
34       id pop-up menu</a> (if you can't see this, then no RNA structure is
35     associated with your sequence or alignment). In the pop-up menu all
36     structures that are associated with this sequence and all sequences
37     that are associated with the alignment are available.
38   <p>
39     Saving a Jalview session as a project file includes the state of any
40     Varna viewers, which are reopened when the project is reloaded <em>(since
41       Jalview 2.9)</em>.
42   <p>
43     <strong>Different structures</strong>
44   </p>
45   <ul>
46     <li><b>Alignment structures</b>: Structures associated with the
47       alignment are marked by having &quot;consensus&quot; attached to
48       their name. VARNA contains two different entries for consensus
49       structures.
50       <ul>
51         <li>Consensus structure: the individual sequence folded
52           into the consensus structure</li>
53         <li>Trimmed consensus structure: the individual sequence
54           folded into the the gap-free consensus structure. That means
55           all columns that contained gaps in the individual sequence
56           were removed. If this breaks a base-pair the pairing is
57           removed also. This can be considered as an approximation for
58           the individual structure.
59       </ul></li>
60     <li><b>Individual structures</b>: this is a structure
61       associated with the individual sequence and therefore not related
62       to the alignment</li>
63   </ul>
64   <p>
65     <strong>Controls</strong><br>
66   <ul>
67     <li>Rotate view - Left Click and drag</li>
68     <li>Zoom in - Press '+'</li>
69     <li>Zoom out - Press '-'</li>
70     <li>Choose a different structure - Left click on structure in
71       the left hand panel</li>
72     <li>Highlighting bases - Move mouse over columns in the Jalview
73       alignment panel</li>
74   </ul>
75
76   <p>
77     <strong>Functionality provided by VARNA</strong>
78   </p>
79   <p>VARNA's own functions are accessed by right-clicking in the
80     structure display area. That will open the VARNA pop-up menu, which
81     provides access to a number of features like different draw
82     algorithm, color highlighting or annotations.</p>
83   <p>
84     <strong>More Information</strong>
85   </p>
86   <p>
87     VARNA is a very powerful RNA viewer on its own. Only the essentials
88     have been described here - the interested reader is referred to <a
89       href="http://varna.lri.fr/index.php?page=manual&css=varna">VARNA's
90       own comprehensive online documentation</a>.
91   </p>
92 </body>
93 </html>