Skip to content

Commit 2fa95e4

Browse files
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
1 parent 2e0db10 commit 2fa95e4

File tree

11 files changed

+28
-36
lines changed

11 files changed

+28
-36
lines changed

DESCRIPTION

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: antaresEditObject
22
Type: Package
33
Title: Edit an 'Antares' Simulation
4-
Version: 0.8.0.9000
4+
Version: 0.9.0
55
Authors@R: c(
66
person("Tatiana", "Vargas", email = "tatiana.vargas@rte-france.com", role = c("aut", "cre")),
77
person("Frederic", "Breant", role = "ctb"),
@@ -53,5 +53,3 @@ Suggests:
5353
knitr,
5454
rmarkdown
5555
VignetteBuilder: knitr
56-
Remotes:
57-
rte-antares-rpackage/antaresRead

NEWS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> Copyright © 2016 RTE Reseau de transport d’electricite
22
3-
# antaresEditObject 0.8.0.9000
3+
# antaresEditObject 0.9.0
44
(cf. Antares v9 changelog)
55

66
NEW FEATURES (Antares v9.0) :
@@ -14,7 +14,7 @@ BUGFIXES :
1414
- To add values, the `operator` parameter is now required.
1515
- 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.
1616
* *[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).
17-
- You can use global parameter `verbose` to `TRUE` (#274 `antaresRead`) to display diagnostic messages (`getOption("antares")`)
17+
- 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")`)
1818
* `updateAdequacySettings()` : in API mode do not send NULL value
1919

2020

R/playlist.R

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11

22
#' @title Get the playlist of an Antares study
3-
#' `r antaresEditObject:::badge_api_ok()`
3+
#'
44
#'
5-
#' @description \code{getPlaylist} gives the identifier of the MC years which
5+
#' @description
6+
#' `r antaresEditObject:::badge_api_ok()`
7+
#'
8+
#' \code{getPlaylist} gives the identifier of the MC years which
69
#' will be simulated in the Antares study, taking into account the potential use of a
710
#' playlist which can skip some MC years
811
#'

R/updateGeneralSettings.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
#' @importFrom antaresRead setSimulationPath readIniFile
5151
#' @importFrom lifecycle is_present deprecate_warn deprecated
5252
#'
53-
#' @seealso \href{https://antares-simulator.readthedocs.io/en/latest/user-guide/solver/04-parameters/}{Antares General Reference Guide}
53+
#' @seealso {Antares General Reference Guide}
5454
#'
5555
#' @examples
5656
#' \dontrun{

R/updateOutputSettings.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
#' @importFrom utils modifyList
2222
#' @importFrom antaresRead readIniFile
2323
#'
24-
#' @seealso \href{https://antares-simulator.readthedocs.io/en/latest/user-guide/solver/04-parameters/}{Antares General Reference Guide}
24+
#' @seealso {Antares General Reference Guide}
2525
#'
2626
#' @examples
2727
#' \dontrun{

cran-comments.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,15 @@ This error did not appear on the CRAN
5858
- `\dontrun{}` sections are needed because most of functions need to be apply on a study load on Global env (legacy code too)
5959
- There is only a maintainer, contributors and RTE, which is the owner. (we use `use_gpl_license(version = 2, include_future = TRUE)`)
6060

61+
62+
## antaresEditObject 0.9.0
63+
64+
### Re Submission and check doc with command below
65+
66+
```r
67+
devtools::check(manual = TRUE,
68+
remote = TRUE,
69+
incoming = TRUE)
70+
```
71+
No more "Found the following (possibly) invalid URLs"
72+

man/playlist.Rd

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/updateGeneralSettings.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/updateOutputSettings.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/api-variant-management.Rmd

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,7 @@ writeVariantCommands("path/to/commands.json")
106106

107107
Below are listed all functions from {antaresEditObject} that can be used with the API. These functions will include the following badge in their documentation:
108108

109-
```{r, echo=FALSE}
110-
knitr::include_graphics("figures/badge_api_ok.svg")
111-
```
109+
![](https://img.shields.io/badge/Antares%20API-OK-green)
112110

113111

114112
### Create an area

0 commit comments

Comments
 (0)