help/help/html/io/paematrixformat.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>Supported Formats for Predicted Alignment Error Matrices</title>
  24 </head>
  25
  26 <body>
  27         <p>
  28                 <strong>Supported Formats for Predicted Alignment Error
  29                         Matrices</strong>
  30         </p>
  31         <p>
  32                 Predicted Alignment Error matrices are square matrices produced as
  33                 part of deep-learning based 3D-structure prediction pipelines such as
  34                 AlphaFold. They can be imported via <a
  35                         href="../features/structurechooser.html">Jalview's structure
  36                         chooser</a> GUI and the <a href="../features/clarguments-basic.html">Command
  37                         Line Interface</a>. See <a href="../features/paematrices.html">Working
  38                         with PAE Matrices</a> for information on how they are visualised and
  39                 analysed in Jalview.
  40         </p>
  41         <p>
  42                 <strong>Supported Formats</strong>
  43         </p>
  44         <p>Jalview supports import of PAE matrix data as provided by the
  45                 EBI-AlphaFold database. This resource provides PAE matrices as a JSON
  46                 files structured in one of the following ways:</p>
  47         <pre>
  48         # Version 1 format PAE file - deprecated 28th July 2022
  49         {
  50                 residue1:[1,1,... total number of residues]
  51                 residue2:[1,2,... total number of residues]
  52                 distance:[0.1,0.3,... list of PAE matrix elements as doubles]
  53         }
  54   </pre>
  55   <pre>
  56         # Version 2 format PAE file - see https://alphafold.ebi.ac.uk/faq
  57         {
  58                 max_predicted_alignment_error: 4.0, # may also be max_pae
  59                 predicted_alignment_error: [[1,2,0,0,3,...],...] # may also be pae
  60         }
  61   </pre>
  62         <p>
  63                 Variants of the version 2 format include using 'pae' instead of
  64                 'predicted_alignment_error' in the names of keys. Jalview copes both.<br />
  65                 Once imported, Jalview stores PAE matrices as float arrays along with
  66                 any associated tree and partition set resultant from clustering the
  67                 matrix. <br/><br/><em>PAE Matrix import support was added in Jalview 2.11.3
  68                 </em>
  69         </p>
  70 </body>
  71 </html>