From 2fa95e48addb915696e5c0091ddcfa32b2861fc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Berthet?= Date: Mon, 17 Feb 2025 10:48:08 +0100 Subject: [PATCH] CRAN release v0.9.0 (#198) * bump to v0.9.0 to CRAN release + delete dev deps antaresRead remotes * fix newsmd url to PR * fix error 404 url in R code + rebuild doc + add comment to cran-comments, check command * playlist update doc to put badge api is section Description * fix warning when build doc site with .svg image to display badge API, updated by badge link --- DESCRIPTION | 4 +--- NEWS.md | 4 ++-- R/playlist.R | 7 +++++-- R/updateGeneralSettings.R | 2 +- R/updateOutputSettings.R | 2 +- cran-comments.md | 12 ++++++++++++ man/playlist.Rd | 5 +++-- man/updateGeneralSettings.Rd | 2 +- man/updateOutputSettings.Rd | 2 +- vignettes/api-variant-management.Rmd | 4 +--- vignettes/figures/badge_api_ok.svg | 20 -------------------- 11 files changed, 28 insertions(+), 36 deletions(-) delete mode 100644 vignettes/figures/badge_api_ok.svg diff --git a/DESCRIPTION b/DESCRIPTION index 403e6578..700ec7b9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: antaresEditObject Type: Package Title: Edit an 'Antares' Simulation -Version: 0.8.0.9000 +Version: 0.9.0 Authors@R: c( person("Tatiana", "Vargas", email = "tatiana.vargas@rte-france.com", role = c("aut", "cre")), person("Frederic", "Breant", role = "ctb"), @@ -53,5 +53,3 @@ Suggests: knitr, rmarkdown VignetteBuilder: knitr -Remotes: - rte-antares-rpackage/antaresRead diff --git a/NEWS.md b/NEWS.md index d322e8c5..ce75fb82 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,6 @@ > Copyright © 2016 RTE Reseau de transport d’electricite -# antaresEditObject 0.8.0.9000 +# antaresEditObject 0.9.0 (cf. Antares v9 changelog) NEW FEATURES (Antares v9.0) : @@ -14,7 +14,7 @@ BUGFIXES : - To add values, the `operator` parameter is now required. - For a study version >= 832, the `filter-year-by-year` and `filter-synthesis` properties are retained in the .ini file if they are not modified. * *[private function]* `api_command_execute()` manage snapshot generation of a variant study with a tempo to wait the end of current task (prevents the order from being ignored). - - You can use global parameter `verbose` to `TRUE` (#274 `antaresRead`) to display diagnostic messages (`getOption("antares")`) + - You can use global parameter `verbose` to `TRUE` ([#274](https://github.com/rte-antares-rpackage/antaresRead/pull/274) `antaresRead`) to display diagnostic messages (`getOption("antares")`) * `updateAdequacySettings()` : in API mode do not send NULL value diff --git a/R/playlist.R b/R/playlist.R index b3b9b224..97055357 100644 --- a/R/playlist.R +++ b/R/playlist.R @@ -1,8 +1,11 @@ #' @title Get the playlist of an Antares study -#' `r antaresEditObject:::badge_api_ok()` +#' #' -#' @description \code{getPlaylist} gives the identifier of the MC years which +#' @description +#' `r antaresEditObject:::badge_api_ok()` +#' +#' \code{getPlaylist} gives the identifier of the MC years which #' will be simulated in the Antares study, taking into account the potential use of a #' playlist which can skip some MC years #' diff --git a/R/updateGeneralSettings.R b/R/updateGeneralSettings.R index 2837e2e1..c42b0014 100644 --- a/R/updateGeneralSettings.R +++ b/R/updateGeneralSettings.R @@ -50,7 +50,7 @@ #' @importFrom antaresRead setSimulationPath readIniFile #' @importFrom lifecycle is_present deprecate_warn deprecated #' -#' @seealso \href{https://antares-simulator.readthedocs.io/en/latest/user-guide/solver/04-parameters/}{Antares General Reference Guide} +#' @seealso {Antares General Reference Guide} #' #' @examples #' \dontrun{ diff --git a/R/updateOutputSettings.R b/R/updateOutputSettings.R index 89ef3bc4..cd83209c 100644 --- a/R/updateOutputSettings.R +++ b/R/updateOutputSettings.R @@ -21,7 +21,7 @@ #' @importFrom utils modifyList #' @importFrom antaresRead readIniFile #' -#' @seealso \href{https://antares-simulator.readthedocs.io/en/latest/user-guide/solver/04-parameters/}{Antares General Reference Guide} +#' @seealso {Antares General Reference Guide} #' #' @examples #' \dontrun{ diff --git a/cran-comments.md b/cran-comments.md index 5735195b..aa7b2d06 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -58,3 +58,15 @@ This error did not appear on the CRAN - `\dontrun{}` sections are needed because most of functions need to be apply on a study load on Global env (legacy code too) - There is only a maintainer, contributors and RTE, which is the owner. (we use `use_gpl_license(version = 2, include_future = TRUE)`) + +## antaresEditObject 0.9.0 + +### Re Submission and check doc with command below + +```r +devtools::check(manual = TRUE, + remote = TRUE, + incoming = TRUE) +``` +No more "Found the following (possibly) invalid URLs" + diff --git a/man/playlist.Rd b/man/playlist.Rd index 2876b1bf..582d35b6 100644 --- a/man/playlist.Rd +++ b/man/playlist.Rd @@ -4,8 +4,7 @@ \alias{playlist} \alias{getPlaylist} \alias{setPlaylist} -\title{Get the playlist of an Antares study -\ifelse{html}{\figure{badge_api_ok.svg}{options: alt='Antares API OK'}}{Antares API: \strong{OK}}} +\title{Get the playlist of an Antares study} \usage{ getPlaylist(opts = antaresRead::simOptions()) @@ -29,6 +28,8 @@ setPlaylist(playlist, weights = NULL, opts = antaresRead::simOptions()) } } \description{ +\ifelse{html}{\figure{badge_api_ok.svg}{options: alt='Antares API OK'}}{Antares API: \strong{OK}} + \code{getPlaylist} gives the identifier of the MC years which will be simulated in the Antares study, taking into account the potential use of a playlist which can skip some MC years diff --git a/man/updateGeneralSettings.Rd b/man/updateGeneralSettings.Rd index 698cdc00..ac11b0dd 100644 --- a/man/updateGeneralSettings.Rd +++ b/man/updateGeneralSettings.Rd @@ -135,5 +135,5 @@ updateGeneralSettings(generate = c("thermal", "hydro")) } } \seealso{ -\href{https://antares-simulator.readthedocs.io/en/latest/user-guide/solver/04-parameters/}{Antares General Reference Guide} +{Antares General Reference Guide} } diff --git a/man/updateOutputSettings.Rd b/man/updateOutputSettings.Rd index 61b58ff5..171065f9 100644 --- a/man/updateOutputSettings.Rd +++ b/man/updateOutputSettings.Rd @@ -48,5 +48,5 @@ updateOutputSettings( } \seealso{ -\href{https://antares-simulator.readthedocs.io/en/latest/user-guide/solver/04-parameters/}{Antares General Reference Guide} +{Antares General Reference Guide} } diff --git a/vignettes/api-variant-management.Rmd b/vignettes/api-variant-management.Rmd index 62412afa..acc72695 100644 --- a/vignettes/api-variant-management.Rmd +++ b/vignettes/api-variant-management.Rmd @@ -106,9 +106,7 @@ writeVariantCommands("path/to/commands.json") Below are listed all functions from {antaresEditObject} that can be used with the API. These functions will include the following badge in their documentation: -```{r, echo=FALSE} -knitr::include_graphics("figures/badge_api_ok.svg") -``` +![](https://img.shields.io/badge/Antares%20API-OK-green) ### Create an area diff --git a/vignettes/figures/badge_api_ok.svg b/vignettes/figures/badge_api_ok.svg deleted file mode 100644 index a210e856..00000000 --- a/vignettes/figures/badge_api_ok.svg +++ /dev/null @@ -1,20 +0,0 @@ - - Antares API: OK - - - - - - - - - - - - - \ No newline at end of file