From ce09eb716a36316ced7a0cb64f718c0c7db34ca1 Mon Sep 17 00:00:00 2001
From: Gabriel Studer <gabriel.studer@unibas.ch>
Date: Thu, 9 Mar 2023 19:25:17 +0100
Subject: [PATCH] docu updates
---
modules/mol/alg/pymod/lddt.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/modules/mol/alg/pymod/lddt.py b/modules/mol/alg/pymod/lddt.py
index 0f464d02b..ff6119a53 100644
--- a/modules/mol/alg/pymod/lddt.py
+++ b/modules/mol/alg/pymod/lddt.py
@@ -403,7 +403,11 @@ class lDDTScorer:
:param model: Model to be scored - models are preferably scored upon
performing stereo-chemistry checks in order to punish for
non-sensical irregularities. This must be done separately
- as a pre-processing step.
+ as a pre-processing step. Target contacts that are not
+ covered by *model* are considered not conserved, thus
+ decreasing lDDT score. This also includes missing model
+ chains or model chains for which no mapping is provided in
+ *chain_mapping*.
:type model: :class:`ost.mol.EntityHandle`/:class:`ost.mol.EntityView`
:param thresholds: Thresholds of distance differences to be considered
as correct - see docs in constructor for more info.
--
GitLab