From 8e5089b5b52bea72830f6cd119aaf90fee26a93e Mon Sep 17 00:00:00 2001
From: FAGES Timothee <timothee.fages@univ-lorraine.fr>
Date: Tue, 25 Jun 2024 10:13:22 +0000
Subject: [PATCH] Update file README.md
---
README.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 7d46d32..0a6379c 100644
--- a/README.md
+++ b/README.md
@@ -66,12 +66,15 @@ Each line starting with !CHECK needs to be looked carefully. Choose the right tr
If you want to remove a translation, you can comment the line with "!" or change the species with a None.
Everything after a "!" on a line will be treated as a comment.
Explanation of a !CHECK line :
-- !CHECK species_to_translate = [species1, species2, species3] ![value1, value2, value3]
+- !CHECK species_to_translate = [species1, species2, species3] ![value1, value2, value3]
+
- First list [species1, species2, species3]
species1: This is the species name given by the first translation method.
species2: This is the species name corresponding to the best arrangement found by the second translation method.
species3: This is the species name corresponding to the second-best arrangement found by the second translation method.
+
An arrangement here refers to the match found between all the species to be translated (in the isomer group) and all the species used for translation (in the isomer group). The best arrangement is the one with the minimum mean normalized mean absolute difference (mean NMAD).
+
- Second list [value1, value2, value3]
value1: This is the direct NMAD between the species_to_translate and species1, given by the first method.
value2: This is the mean NMAD for the best arrangement of the whole isomer group, given by the second method.
--
GitLab