From 363121f01a9acdfa65aeff41219377a62c236d93 Mon Sep 17 00:00:00 2001
From: MANSOURI Assil Ext <assil.mansouri@rte-france.com>
Date: Fri, 10 Mar 2023 17:25:47 +0100
Subject: [PATCH] docs + test notes

---
 R/computeTimeStampFromHourly.R                  | 2 ++
 R/computeTimeStepFromHourly.R                   | 4 ++++
 man/computeOtherFromHourlyMulti.Rd              | 3 +++
 man/computeOtherFromHourlyYear.Rd               | 3 +++
 man/computeTimeStampFromHourly.Rd               | 3 +++
 tests/testthat/test-computeTimeStepFromHourly.R | 2 +-
 6 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/R/computeTimeStampFromHourly.R b/R/computeTimeStampFromHourly.R
index 945b1c41..61f04941 100644
--- a/R/computeTimeStampFromHourly.R
+++ b/R/computeTimeStampFromHourly.R
@@ -1,5 +1,7 @@
 #' @title Compute daily, weekly, monthly and annual mc-ind from hourly data.
 #' 
+#' @note Deprecated on studies v8 or higher.
+#' 
 #' @description 
 #' `r antaresEditObject:::badge_api_no()`
 #' 
diff --git a/R/computeTimeStepFromHourly.R b/R/computeTimeStepFromHourly.R
index fb883fba..f080c494 100644
--- a/R/computeTimeStepFromHourly.R
+++ b/R/computeTimeStepFromHourly.R
@@ -174,6 +174,8 @@
 
 #' @title Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)
 #' 
+#' @note Recommended only with studies spanning on two years.
+#' 
 #' @param mcYear vector of years to compute
 #' @param type type of data (areas, links, clusters, clustersRes)
 #' @param areas vector of areas. links type will use getLinks() to get data.
@@ -253,6 +255,8 @@ computeOtherFromHourlyYear <- function(mcYear,
 
 
 #' @title Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)
+#'
+#' @note Recommended only with studies spanning on two years.
 #' 
 #' @param opts study opts
 #' @param areas vector of areas
diff --git a/man/computeOtherFromHourlyMulti.Rd b/man/computeOtherFromHourlyMulti.Rd
index cde59dd6..dd14855a 100644
--- a/man/computeOtherFromHourlyMulti.Rd
+++ b/man/computeOtherFromHourlyMulti.Rd
@@ -35,6 +35,9 @@ computeOtherFromHourlyMulti(
 \description{
 Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)
 }
+\note{
+Recommended only with studies spanning on two years.
+}
 \seealso{
 \code{\link{computeOtherFromHourlyYear}}
 }
diff --git a/man/computeOtherFromHourlyYear.Rd b/man/computeOtherFromHourlyYear.Rd
index e6e6357b..c8d73762 100644
--- a/man/computeOtherFromHourlyYear.Rd
+++ b/man/computeOtherFromHourlyYear.Rd
@@ -29,6 +29,9 @@ computeOtherFromHourlyYear(
 \description{
 Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)
 }
+\note{
+Recommended only with studies spanning on two years.
+}
 \seealso{
 \code{\link{computeOtherFromHourlyMulti}}
 }
diff --git a/man/computeTimeStampFromHourly.Rd b/man/computeTimeStampFromHourly.Rd
index b7932087..8b7feb41 100644
--- a/man/computeTimeStampFromHourly.Rd
+++ b/man/computeTimeStampFromHourly.Rd
@@ -28,6 +28,9 @@ computeTimeStampFromHourly(
 
 Compute daily, weekly, monthly and annual mc-ind from hourly data.
 }
+\note{
+Deprecated on studies v8 or higher.
+}
 \examples{
 \dontrun{
 
diff --git a/tests/testthat/test-computeTimeStepFromHourly.R b/tests/testthat/test-computeTimeStepFromHourly.R
index 7b1760f1..0523d762 100644
--- a/tests/testthat/test-computeTimeStepFromHourly.R
+++ b/tests/testthat/test-computeTimeStepFromHourly.R
@@ -1,6 +1,6 @@
 context("Function new computeOtherFromHourly")
 
-skip("")
+skip("Function requires study that spans on 2 years (TODO)")
 
 sapply(studies[2], function(study) {