docs + test notes

rte-antares-rpackage · Mar 10, 2023 · 363121f · 363121f
1 parent 780eddf
commit 363121f
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 1 deletion.
diff --git 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
@@ -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
diff --git a/man/computeOtherFromHourlyYear.Rd b/man/computeOtherFromHourlyYear.Rd
diff --git a/man/computeTimeStampFromHourly.Rd b/man/computeTimeStampFromHourly.Rd
diff --git 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) {