JAL-1645 JAL-1595 sort by RNA helices docs
[jalview.git] / help / html / na / index.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>Nucleic Acid Support</title>
24 <style type="text/css">
25 <!--
26 td {
27         font-family: "Courier New", Courier, mono;
28         font-style: normal;
29         font-size: medium;
30 }
31 -->
32 </style>
33 </head>
34 <body>
35         <p>
36                 <strong>Nucleic Acid Support</strong>
37         </p>
38         <p>
39                 <em>Colour Schemes</em>
40         </p>
41         <p>Jalview has color schemes for nucleic acid based sequences,
42                 ability to fetch sequences from RFAM and RNA secondary structure
43                 coloring</p>
44         <p>
45                 Information on the <a href="../colourSchemes/nucleotide.html">Nucleotide
46                         colour scheme</a> and <a href="../colourSchemes/purinepyrimidine.html">
47                         Purine/Pyrimidine colour scheme</a> are available under the Colour Menu.
48                 See <a href="../colourSchemes/index.html">Colour Schemes</a>.
49         </p>
50         <p>
51                 <em>RNA Support</em>
52         </p>
53         Jalview supports annotation of RNA sequences with secondary structure
54         information. You can interactively
55         <a href="../features/annotation.html#rna">create and edit RNA
56                 secondary structure annotation rows</a>, or import data in the following
57         way:
58         <ul>
59                 <li><em>RFAM</em> - Sequences can be <a
60                         href="../features/seqfetch.html">fetched</a> from the RFAM database
61                         by accession number or ID.</li>
62                 <li><em>Stockholm files</em> - WUSS (or VIENNA) dot-bracket
63                         notation found in the secondary structure annotation line will be
64                         imported as sequence or alignment associated secondary structure
65                         annotation.</li>
66                 <li><em>Clustal files</em> - certain RNA alignment programs, such
67                         as <a href="http://rna.informatik.uni-freiburg.de:8080/LocARNA.jsp">LocaRNA</a>
68                         output consensus RNA secondary structure lines in the line normally
69                         reserved for the Clustal consensus line in a clustal file.</li>
70                 <li><em>RNAML</em> Jalview can import RNAML files containing sequences and extended secondary structure annotation derived from RNA 3D structure</li>
71         </ul>
72         <p>
73                 <strong>RNA Secondary Structure Visualization and Analysis</strong><br />
74                 If a sequence or RNA alignment has secondary structure information,
75                 the alignment will have a secondary structure line shown below it, and
76                 a number of additional options become available:
77         <ul>
78                 <li><a href="../colourschemes/rnaHelicesColouring.html">RNA
79                                 Helix colouring</a> - highlights columns of alignment involved in
80                         particular RNA helices, Uses the first displayed secondary structure annotation.</li>
81       <li><a href="../calculations/structureconsensus.html">Base Pair
82                                 Conservation Analysis</a> - shown as a histogram and base-pair logo
83                         below the alignment. Uses the first displayed secondary structure annotation row.</li>
84                 <li><a href="../features/varna.html">2D Structure
85                                 Visualization in VARNA</a> - allows linked viewing of the consensus or
86                         an individual sequence's structure. Accessed via the Sequence ID popup menu.</li>
87     <li><strong>per sequence secondary structure
88         annotation</strong><br /> Sequence associated secondary structure
89       annotation imported via stockholm, PDB files, or other sources can
90       be shown on the alignment with the <strong>Colours&#8594;By
91         Annotation</strong> dialog box. Colours are assigned according to RNA
92       helix topology number (number of distinct nested helices).
93       Alignments can also be sorted by RNA helix secondary structure
94       topology number, <em>via</em> the <strong>Calculations&#8594;Sort&#8594;By
95         Annotation&#8594;Secondary Structure</strong> option (only present when
96       per-sequence secondary structure is available).</li>
97   </ul>
98         <p><strong>Pseudo-knots</strong><br/>
99           Jalview 2.8.2 introduced limited support for working with structures including pseudoknots. Where possible, extended WUSS symbols (e.g. different types of parentheses, or upper and lower case letters) are preserved when parsing RNA structure annotation and will be shaded differently when displayed in the structure.<br/>
100   Extended WUSS annotation is also employed to distinguish different base pair interactions obtained from RNAML files.</p>
101           
102         <p><strong>Limitations when working with RNA in Jalview</strong><br/>
103         Currently, Jalview is not able to export RNA secondary structure annotation in any format other than Jalview annotation
104         </br>
105         <em>Jalview's RNA handling capabilities were introduced in v2.8</em>
106         </p>
107         <p align="center">&nbsp;</p>
108 </body>
109 </html>