Update documentation with the new function .importOutputForSTClusters()

rte-antares-rpackage · Jun 12, 2024 · a117df4 · a117df4
1 parent facff5f
commit a117df4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/R/importOutput.R b/R/importOutput.R
@@ -281,8 +281,8 @@
 
 #' .get_value_columns_details_file
 #'
-#' Private function used to get the column names for the details-timeStep.txt or details-res-timeStep.txt.
-#' Used in .importOutputForClusters() and .importOutputForResClusters()
+#' Private function used to get the column names for the details-timeStep.txt, details-res-timeStep.txt, or details-STstorage-timeStep.txt.
+#' Used in .importOutputForClusters(), .importOutputForResClusters(), and .importOutputForSTClusters()
 #' From the opts, we detect which outputs the user decides to take 
 #'
 #' @return

diff --git a/R/readAntares.R b/R/readAntares.R
@@ -14,6 +14,8 @@
 #' Read the data of an Antares simulation
 #'
 #' @description
+#' `r antaresRead:::badge_api_ok()`
+#' 
 #' \code{readAntares} is a swiss-army-knife function used to read almost every
 #' possible time series of an antares Project at any desired time resolution
 #' (hourly, daily, weekly, monthly or annual).

diff --git a/man/readAntares.Rd b/man/readAntares.Rd