From 18fda8a0e5fc869f4c7d28406f02190d51d2f0d8 Mon Sep 17 00:00:00 2001
From: Benjamin Linard <22132778+blinard-BIOINFO@users.noreply.github.com>
Date: Sat, 20 Nov 2021 14:13:44 +0100
Subject: [PATCH] Update README.md
---
README.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/README.md b/README.md
index 114c68b..7718158 100755
--- a/README.md
+++ b/README.md
@@ -14,6 +14,28 @@
*Bioinformatics, btaa657, 22 July 2020*
+## Important notices
+
+
+```diff
+
+11/2021
+
+Following a wrong refactoring, bug in the ND computation was introduced and is now fixed.
+It was located in the java code of the PEWO_java subrepository (which is in charge of computaing node distances).
+Every node distance (ND) reported by PEWO was consistenlty shifted by +1, making every reported value ND+1.
+This +1 shift occured consistently for any query sequence, whatever the selected inputs, software or software parameters.
+
+CONSEQUENTLY, EXPERIMENTS AND SOFTWARE COMPARISONS PRIOR TO THE BUGFIX ARE STILL VALID.
+
+Values reported by PEWO in final tables and plots were just shifted by +1.
+Following the bugfix there is no shift anymore.
+The error was hard to spot as in most experimental setups average NDs are higher than 0 or 1.
+
+Following this bugfix. PEWO has been attributed a 1.0.0 version tag.
+```
+
+
## Overview
PEWO compiles a set of workflows dedicated to the evaluation of phylogenetic placement algorithms and their software implementation. It focuses on reporting placement accuracy under different conditions and associated computational costs.