export check antares version

rte-antares-rpackage · May 2, 2019 · a34d25e · a34d25e
1 parent a574730
commit a34d25e
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 2 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: antaresEditObject
 Type: Package
 Title: Edit an 'Antares' Simulation
-Version: 0.1.5.950
+Version: 0.1.5.960
 Authors@R: c(
     person("Frederic", "Breant", email = "frederic.breant@rte-france.com", role = c("aut", "cre")),
     person("Victor", "Perrier", email = "victor.perrier@dreamRs.fr", role = c("aut")),

diff --git a/NAMESPACE b/NAMESPACE
@@ -20,6 +20,7 @@ export(filteringOptions)
 export(getCapacityDSR)
 export(getCapacityPSP)
 export(getPlaylist)
+export(is_antares_v7)
 export(nodalOptimizationOptions)
 export(propertiesLinkOptions)
 export(readIniFile)

diff --git a/R/checkVersion.R b/R/checkVersion.R
@@ -1,5 +1,23 @@
 
-is_antares_v7 <- function(opts) {
+#' Is study an Antares v7 study ?
+#'
+#' @param opts
+#'   List of simulation parameters returned by the function
+#'   \code{antaresRead::setSimulationPath} 
+#'
+#' @return a logical, \code{TRUE} if study is v7 or above, \code{FALSE} otherwise
+#' @export
+#'
+#' @examples
+#' 
+#' \dontrun{
+#' # setSimulationPath
+#' 
+#' is_antares_v7()
+#' 
+#' }
+#' 
+is_antares_v7 <- function(opts = antaresRead::simOptions()) {
   new_version <- getOption("antares.version.new", default = 700)
   new_version <- as.numeric(new_version)
   isTRUE(opts$antaresVersion >= new_version)

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