From b195573ca5c493cf852d5bcf07669b8c117fa80e Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Wed, 25 Oct 2023 11:06:33 +0200
Subject: [PATCH] docs(man): add equations in 'ErrorCrit_*' help pages

---
 man/ErrorCrit_KGE.Rd  | 2 +-
 man/ErrorCrit_KGE2.Rd | 2 +-
 man/ErrorCrit_NSE.Rd  | 2 +-
 man/ErrorCrit_RMSE.Rd | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/man/ErrorCrit_KGE.Rd b/man/ErrorCrit_KGE.Rd
index 2c17cb54..ddbf6afb 100644
--- a/man/ErrorCrit_KGE.Rd
+++ b/man/ErrorCrit_KGE.Rd
@@ -45,7 +45,7 @@ ErrorCrit_KGE(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
 
 \details{
 In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
-the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised (Multiplier = -1 for KGE).\cr\cr
+the use of the function for model calibration: the product \eqn{CritValue \times Multiplier} is the criterion to be minimised (Multiplier = -1 for KGE).\cr\cr
 The KGE formula is
 \deqn{KGE = 1 - \sqrt{(r - 1)^2 + (\alpha - 1)^2 + (\beta - 1)^2}}{KGE = 1 - sqrt((r - 1)² + (\alpha - 1)² + (\beta - 1)²)}
 with the following sub-criteria:
diff --git a/man/ErrorCrit_KGE2.Rd b/man/ErrorCrit_KGE2.Rd
index 98e609b7..d4ae8c03 100644
--- a/man/ErrorCrit_KGE2.Rd
+++ b/man/ErrorCrit_KGE2.Rd
@@ -45,7 +45,7 @@ ErrorCrit_KGE2(InputsCrit, OutputsModel, warnings = TRUE, verbose = TRUE)
 
 \details{
 In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
-the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised (Multiplier = -1 for KGE2).\cr\cr
+the use of the function for model calibration: the product \eqn{CritValue \times Multiplier} is the criterion to be minimised (Multiplier = -1 for KGE2).\cr\cr
 The KGE' formula is
 \deqn{KGE' = 1 - \sqrt{(r - 1)^2 + (\gamma - 1)^2 + (\beta - 1)^2}}{KGE' = 1 - sqrt((r - 1)² + (\gamma - 1)² + (\beta - 1)²)}
 with the following sub-criteria:
diff --git a/man/ErrorCrit_NSE.Rd b/man/ErrorCrit_NSE.Rd
index 47f838e2..879ec721 100644
--- a/man/ErrorCrit_NSE.Rd
+++ b/man/ErrorCrit_NSE.Rd
@@ -43,7 +43,7 @@ Function which computes an error criterion based on the NSE formula proposed by
 
 \details{
 In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
-the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised
+the use of the function for model calibration: the product \eqn{CritValue \times Multiplier} is the criterion to be minimised
 (Multiplier = -1 for NSE).
 }
 
diff --git a/man/ErrorCrit_RMSE.Rd b/man/ErrorCrit_RMSE.Rd
index 89bc0223..82fac665 100644
--- a/man/ErrorCrit_RMSE.Rd
+++ b/man/ErrorCrit_RMSE.Rd
@@ -43,7 +43,7 @@ Function which computes an error criterion based on the root-mean-square error (
 
 \details{
 In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows 
-the use of the function for model calibration: the product CritValue * Multiplier is the criterion to be minimised 
+the use of the function for model calibration: the product \eqn{CritValue \times Multiplier} is the criterion to be minimised 
 (Multiplier = +1 for RMSE).
 }
 
-- 
GitLab