JAL-3858 JAL-4090 PAE documentation..
[jalview.git] / help / help / html / features / paematrices.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>Working with PAE Matrices in Jalview</title>
24 </head>
25
26 <body>
27         <p>
28                 <strong>Working with Predicted Alignment Error Matrices in
29                         Jalview</strong>
30         </p>
31
32         <p>Predicted Alignment Error (PAE) matrices are produced by deep-learning
33                 based 3D-structure prediction pipelines such as AlphaFold. They reflect how reliably two parts of a model have been positioned in space, by giving for each residue the likely error (in Angstroms) between the modelled position and the pair of residues' real relative position.</p>
34                 <p>
35                 Jalview visualises PAE matrices as an alignment annotation track, shaded from dark green to white, as used on the EBI-AlphaFold website (see )
36                 </p>
37         <p>
38                 <strong>Importing PAE Matrices</strong>
39         </p>
40         <p>
41                 Jalview retrieves PAE matrices when importing predicted 3D structures
42                 from the EBI-AlphaFold database via <a
43                         href="../features/structurechooser.html">Jalview's structure
44                         chooser</a> GUI. If you have produced your own models and accompanying
45                 PAE matrices using a pipeline such as ColabFold, then you can load
46                 them both together via the <a
47                         href="../features/structurechooser.html#loadpdbfile">Load PDB
48                         File</a> dropdown menu in the 3D structure chooser. in a <a
49                         href="../io/paematrixformat.html">supported PAE format</a>.
50         </p>
51         <p>
52                 The <a href="../features/clarguments-basic.html">Command Line
53                         Interface</a> also provides a options for importing PAE matrices along
54                 side models, enabling the automated production of alignment figures
55                 annotated with PAE matrices and PLDDT scores.
56         </p>
57         <p>
58                 See <a href="../features/paematrices.html">Working with PAE
59                         Matrices</a> for information on how they are visualised and analysed in
60                 Jalview.
61         </p>
62         </p>
63         <p>
64                 An additional <em>Predicted Alignment Error</em> file can also be
65                 provided when importing 3D structure data. Jalview supports import of
66                 PAE Matrices provided as <a href="../io/paematrixformat.html">AlphaFold
67                         format JSON files</a> - which are also produced by ColabFold. See <a
68                         href="paematrices.html">Working with PAE Matrices</a> for details on
69                 what Jalview allows you to do with associated PAE matrix data.
70         </p>
71         <p>
72                 <em>The Structure Chooser interface was introduced in Jalview
73                         2.9. </em>
74         </p>
75 </body>
76 </html>