Skip to content

Commit

Permalink
CRAN release v0.9.0 (#198)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
berthetclement authored Feb 17, 2025
1 parent 2e0db10 commit 2fa95e4
Show file tree
Hide file tree
Showing 11 changed files with 28 additions and 36 deletions.
4 changes: 1 addition & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]", role = c("aut", "cre")),
person("Frederic", "Breant", role = "ctb"),
Expand Down Expand Up @@ -53,5 +53,3 @@ Suggests:
knitr,
rmarkdown
VignetteBuilder: knitr
Remotes:
rte-antares-rpackage/antaresRead
4 changes: 2 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -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) :
Expand All @@ -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


Expand Down
7 changes: 5 additions & 2 deletions R/playlist.R
Original file line number Diff line number Diff line change
@@ -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
#'
Expand Down
2 changes: 1 addition & 1 deletion R/updateGeneralSettings.R
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
2 changes: 1 addition & 1 deletion R/updateOutputSettings.R
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
12 changes: 12 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

5 changes: 3 additions & 2 deletions man/playlist.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/updateGeneralSettings.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/updateOutputSettings.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions vignettes/api-variant-management.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 0 additions & 20 deletions vignettes/figures/badge_api_ok.svg

This file was deleted.

0 comments on commit 2fa95e4

Please sign in to comment.