0dc7475229738fc4d796f1b92b5871f15d180236
[jalview.git] / help / html / features / xsspannotation.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
4  * Copyright (C) 2014 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>Annotation from 3D structure data</title>
24 </head>
25 <body>
26         <p>
27                 <strong>Working with annotation from 3D structure data</strong>
28         </p>
29         <p>
30                 Jalview can process PDB data associated with sequences to display
31                 values extracted from the <em>Temperature Factor</em> column for
32                 corresponding sites, and secondary structure from DSSP or RNAView (as
33                 appropriate).
34         </p>
35         <p>
36                 <strong>Extracting data from PDB files<br /></strong>Annotation is
37                 created for structure files retrieved directly from the PDB loaded
38                 from the file system (via the <strong>Structure&rarr;Associate
39                         Structure...&rarr;From file</strong> option, or when displayed via the View
40                 Structures Menu.<br /> Structure annotation is not automatically
41                 added to an alignment, but any available structure annotation rows for
42                 the current selection or a particular sequence can be added via the <strong>Add
43                         Reference Annotation</strong> in the <strong>Selection</strong> and <strong>Sequence
44                         ID</strong> sub-menus of the Sequence ID Panel's popup menu.<br/> <em>Please
45                         note:</em>Protein structures are analysed
46                 <em>in situ</em>, but Jalview employs a web service to process RNA
47                 structures which can cause long delays if your internet connection is
48                 slow.
49         </p>
50         <p>
51                 The <a href="../menus/alwannotation.html"><em>Annotations</em>
52                         alignment menu</a> provides settings useful for controlling the display
53                 of secondary structure annotation.
54         </p>
55         <p>
56                 <strong>Shading sequences by associated structure annotation<br /></strong>The
57                 annotation colouring dialog (opened by the <strong>Colour&rarr;By
58                         Annotation</strong> option) allows sequences with associated secondary
59                 structure data to be shaded according to secondary structure type.
60                 Once the dialog is opened, select the <em>Per Sequence</em> option and
61                 then choose <em>Secondary structure</em> from the dropdown menu.<br />When
62                 colouring alignments by secondary structure, two modes can be
63                 employed. The default is to shade sequences with the same colour as
64                 the secondary structure glyph. If, however, <em>original colours</em>
65                 is selected and another colourscheme has already been applied, then
66                 only portions of the sequence with defined secondary structure will be
67                 shaded with the previously applied scheme.<br />
68         </p>
69         <p>
70                 <strong>Configuration options for processing PDB files<br /></strong>
71                 Occasionally, you may wish to disable secondary structure processing. 
72                 Configuration options in the <strong>Structure</strong> tab in the <strong>Tools&rarr;Preferences</strong>
73                 dialog allow the processing of structure data to be disabled, or
74                 selectively enabled. For more information, take a look at the <a href="preferences.html#structure">documentation for the structure panel</a>.
75         </p>
76         <p>
77                 <em>The display of secondary structure data was introduced in
78                         Jalview 2.8.2, and is made possible by Jalview's use of <a
79                         href="jmol.html">Jmol's DSSP implementation</a>, based on the
80                         original <a href="http://www.ncbi.nlm.nih.gov/pubmed/6667333">Kabsch
81                                 and Sander algorithm</a> ported by <a
82                         href="http://swift.cmbi.ru.nl/gv/dssp/">Robbie P. Joosten and
83                                 colleagues</a>, and a client for <a
84                         href="https://github.com/fjossinet/PyRNA">Fabrice Jossinet's
85                                 pyRNA services</a> that was developed by Anne Menard, Jim Procter and
86                         Yann Ponty as part of the Jalview Summer of Code 2012.
87                 </em>
88         </p>
89 </body>
90 </html>