JAL-892 saved to project; external help link updated
[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><strong>The VARNA RNA Viewer</strong></p>
27 <p><a href="http://varna.lri.fr/index.html">VARNA</a> was
28 integrated into Jalview 2.8 to allow interactive viewing of RNA secondary structure annotation. It is opened by
29 selecting the <strong>&quot;Structure&#8594;View
30 Structure:&quot;</strong> option in
31 the <a href="../menus/popupMenu.html">sequence id pop-up menu</a> (if
32 you can't see this, then no RNA structure is associated with your
33 sequence or alignment). In the pop-up menu all structures that
34 are associated with this sequence and all sequences that are
35 associated with the alignment are available.
36 <p>Saving a Jalview session as a project file includes the state of any Varna viewers, which are reopened when the project is reloaded <em>(since Jalview 2.9)</em>.
37
38 <p><strong>Different structures</strong></p>
39 <ul>
40   <li>
41     <b>Alignment structures</b>:
42     Structures associated with the alignment are marked by having &quot;consensus&quot; attached to their name. VARNA contains two different entries for consensus structures.
43     <ul>
44       <li>Consensus structure: the individual sequence folded into the consensus structure</li>
45       <li>Trimmed consensus structure: the individual sequence
46         folded into the the gap-free consensus structure. That means all
47         columns that contained gaps in the individual sequence were
48         removed. If this breaks a base-pair the pairing is removed also.
49         This can be considered as an approximation for the individual structure.
50     </ul>
51   </li>
52   <li>
53     <b>Individual structures</b>:
54     this is a structure associated with the individual sequence and therefore not related to the alignment    
55   </li>
56 </ul>
57 <p><strong>Controls</strong><br>
58 <ul>
59 <li>Rotate view - Left Click and drag</li>
60 <li>Zoom in - Press '+'</li>
61 <li>Zoom out - Press '-'</li>
62 <li>Choose a different structure - Left click on structure in the left hand panel</li>
63 <li>Highlighting bases - Move mouse over columns in the Jalview alignment panel</li>
64 </ul>
65
66 <p><strong>Functionality provided by VARNA</strong></p>
67 <p>VARNA's own functions are accessed by right-clicking in the
68 structure display area. That will open the VARNA pop-up menu,
69 which provides access to a number of features like different draw algorithm, color highlighting or annotations. 
70 </p>
71 <p><strong>More Information</strong></p>
72 <p>VARNA is a very powerful RNA viewer on its own. Only the
73 essentials have been described here - the interested reader is
74 referred to <a href="http://varna.lri.fr/index.php?page=manual&css=varna">VARNA's own
75 comprehensive online documentation</a>.</p>
76 </body>
77 </html>