From 5780338e17e239a8145ec2f461436ed314fdecc8 Mon Sep 17 00:00:00 2001
From: Gabriel Studer <gabriel.studer@unibas.ch>
Date: Wed, 7 Oct 2020 18:04:46 +0200
Subject: [PATCH] docu updates
---
modules/seq/alg/doc/seqalg.rst | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/modules/seq/alg/doc/seqalg.rst b/modules/seq/alg/doc/seqalg.rst
index c7af50a44..96328e1af 100644
--- a/modules/seq/alg/doc/seqalg.rst
+++ b/modules/seq/alg/doc/seqalg.rst
@@ -435,6 +435,20 @@ differences between the structures.
:type d_map: :class:`DistanceMap`
:raises: Exception if *d_map* has no entries.
+.. function:: CreateMeanlDDTHA(d_map)
+
+ :returns: lDDT calculation based on CA carbons of the structures with lddt
+ distance threshold of 15 Angstrom and distance difference thresholds
+ of [0.5, 1.0, 2.0, 4.0]. The reported values for a certain structure
+ are the mean per-residue lDDT values given all other structures as
+ reference. Structures are in the same order as passed when creating
+ *d_map*.
+
+ :rtype: :class:`MeanlDDT`
+ :param d_map: Distance map as created with :func:`CreateDistanceMap`.
+ :type d_map: :class:`DistanceMap`
+ :raises: Exception if *d_map* has no entries.
+
.. class:: Distances
Container used by :class:`DistanceMap` to store a pair wise distance for each
@@ -632,6 +646,14 @@ differences between the structures.
:rtype: :class:`list` of :class:`list` of :class:`float`
+.. class:: MeanlDDT
+
+ Container returned by :func:`CreateMeanlDDTHA`.
+ Stores mean lDDT values for :meth:`GetNumResidues` residues of
+ :meth:`GetNumStructures` structures.
+ Has the exact same functionality and behaviour as :class:`Dist2Mean`
+
+
HMM Algorithms
--------------------------------------------------------------------------------
Openstructure implements basic HMM-related functionality that aims at
--
GitLab