NEWS.md 17.6 KB
Newer Older
1
## Release History of the airGRteaching Package
2
3
4



5

6

7
8
9
10
### 0.2.12.9000 Release Notes (2021-08-06)
____________________________________________________________________________________


11
### 0.2.12 Release Notes (2021-08-06)
12

13
14
#### Bug fixes

15
16
17
18
19
20
- bug fixed in the GUI launched by `ShinyGR()`, it is possible to the export the GR2M model diagram PNG file again. ([#40](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/40))
- bug fixed in `SimGR()` which can now simulate a period with no observed flow. Previously, it could only be run in this case when the observed flow was missing from the output of `PrepGR()` on the whole period and not just on a subperiod. ([#43](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/43))


#### User-visible changes

21
22
- displaying a message when the package is attached from RStudio and also when the GUI is launched by `ShinyGR()` in order to warn users about GUI instability problems. ([#46](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/46))
- added explanation of the use of the GR5H model in the `PrepGR()` help page. ([#41](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/41))
23
24
25
26
27
28
29
- the text relating to the GR2M model in the 'GUI Help' image displayed by the GUI launched by `ShinyGR()` is corrected. ([#42](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/42))
- replace the use of `class()` by `inherits()` in order to test the classes of inputs in all functions. ([#45](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/45))


#### Version control and issue tracking

- automatic tests implemented in the package. ([#44](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/44))
30
31
32
33

____________________________________________________________________________________


34
### 0.2.11 Release Notes (2021-06-07)
35
36
37

#### Bug fixes

38
- bug fixed in `ShinyGR()` when the date column of `ObsDF` has another name as 'DatesR'. ([#38](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/38))
Delaigue Olivier's avatar
Delaigue Olivier committed
39

40
41
42

#### User-visible changes

43
44
- the `as.data.frame` S3 methods have been set for classes `PrepGR`, `CalGR` and `SimGR`. ([#39](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/39))
- the useless `airGRt` class and the `as.data.frame.airGRt` S3 method no longer exist ([#39](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/39))
45

Delaigue Olivier's avatar
Delaigue Olivier committed
46
47
48
____________________________________________________________________________________


49
### 0.2.10.112 Release Notes (2021-01-23)
50
51


52
#### New features
53

54
- GUI, launched by the `ShinyGR()` function, can now run on monthly time series, using the GR2M model ([#14](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/14))
55
56


57
58
#### Bug fixes

59
- bug fixed in `plot.PrepGR()` when all `Qobs` are missing. The function now displays an empty plot for the observed discharges ([#35](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/35))
60
61


62
#### User-visible changes
63

64
- `theme` agument of the `ShinyGR()` function now uses partial matching ([#12](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/12))
65
- `as.data.frame.airGRt()`, `plot`, `plot.PrepGR()`, `plot.CalGR()` and `plot.SimGR()` functions are no longer exported by the namespace ([#30](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/30))
66
67
68
69
70


#### Version control and issue tracking

- implement automatic tests in the package ([#29](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/29))
71
72


73
74
#### CRAN-compatibility updates

75
- now depends on R >= 3.6.0 in order to be sure to have the packages 'shiny' >= 1.1.0 and 'htmlwidgets' >= 1.5.3 available ([#5](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/5))
76
- now depends on 'airGR' >= 1.6.9.27. 'airGRteaching' uses the new 'Ps' output of the `RunModel_GR2M` function ([#51](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/51)) and the new `SeriesAggreg()` function ([#25](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/25), [#41](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/41), [#43](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/43)) from 'airGR'
77
- now suggests 'htmlwidgets' >= 1.5.3, available on the CRAN. It avoids troubles with the use of dynamic graphics of the 'dygraphs' package (called by the `dyplot*()` and the `ShinyGR()` functions) ([#5](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/5))
78

79
80
81
____________________________________________________________________________________


82
### 0.2.9.25 Release Notes (2020-10-19)
83
84
85
86


#### New features

87
- GUI, launched by the `ShinyGR()` function, now displays a new tab panel that shows a summary sheets of basin if the name of the dataset contains the code station (8 characters : 1 letter and 7 numbers) of the Banque Hydro French database (so it is available only for the dataset of this database) ([#10](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/10))
88
89


90
91
#### Version control and issue tracking

92
- users can now track [changes](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching) and [issues](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues)
93
94


95
#### User-visible changes
96

97
- the `theme` agument of the `ShinyGR()` function now works even if a wrong character case is used
98
99
100
101


#### CRAN-compatibility updates

102
- when the package is attached or when the `dyplot()` and the `ShinyGR()` function are used, a message warns the users if they use a version of 'htmlwidgets' < 1.5.2.9000. The latest version of this package, available on GitHub, avoids troubles with the use of dynamic graphics of the 'dygraphs' package (called by the `dyplot*()` and the `ShinyGR()` functions) ([#5](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/5))
103

104
105
106
____________________________________________________________________________________


107
### 0.2.8.69 Release Notes (2020-02-28)
108
109
110
111


#### New features

112
113
114
- added `as.data.frame.airGRt()` method in order to create a `data.frame` from outputs of `PrepGR()`, `CalGR()` and `SimGR()` functions. This `data.frame` always presents the same structure and contains observed flow, simulated flow, simulated solid precipitation fraction, etc. When it does not make sense, the concerned column is assigned with `NA` values (e.g. Qsim with the `PrepGR()` function)
- a digital object identifier (DOI) now allows to identify the manual of the 'airGRteaching' package. When you use airGRteaching in your work, please always cite both the article and the manual. The last one allows to know the version of the package that is used in order to enhance reproducible research. The references can be displayed with the `citation("airGRteaching")` command
- two themes of alternative stylesheet are available (`"Inrae"` and `"Saclay"`) using the `theme` agument of the `ShinyGR()` function
115

116
117
118

#### Deprecated and defunct

119
- `CalGR` argument is now deprecated in the `SimGR()` function. It has been replaced by the use of the `Param` argument which can be set by an object of the class `CalGR` or by a vector of parameters
120

121

122
123
#### Bug fixes

124
- `ShinyGR()` now runs when independent arguments (`DatesR`, `Precip`, etc.) are used instead of the `ObsDF` argument
125
126


127
128
#### User-visible changes

129
130
131
132
133
134
- it is now possible to use the GR4H and GR5H hourly models with or without CemaNeige. For that, in the `PrepGR()`, the `HydroModel` argument could be set to `"GR4H"` or `"GR5H"`. In the GUI, launched by `ShinyGR()` function, nothing changed, only the daily models are available. So, now airGRteaching depends on the version of 'airGR' >= 1.4.3.52) ([#7](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/7))
- it is now possible to run the `PrepGR()` function when discharge is not provided in `Qobs`. If it is the case, the `CalGR()` function will return an error message because it is not possible to calibrate the model. The `SimGR()` function will return a warning message because it is not possible to compute any efficiency criterion
- it is now possible to run the `ShinyGR()` function when discharge is not provided in `Qobs`
- when observed discharge is provided in `ShinyGR()`, the first plotting panel now draws the flow error time series ([#4](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/4))
- `plot()` function is now exported
- `dyplot.PrepGR()`, `dyplot.CalGR()` and `dyplot.SimGR()` functions are no longer exported
135
- there is now only one help page for all `plot.*()` functions (use `?plot` to call it)
136

137

138
139
#### CRAN-compatibility updates

140
- when the package is loaded, a message warns the users if they use a version of 'htmlwidgets' < 1.5.1.9000. The latest version of this package, available on GitHub, avoids troubles with the use of dynamic graphics of the 'dygraphs' package (called by the `dyplot*()` and the `ShinyGR()` functions) ([#5](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/5))
141

142
143
144
____________________________________________________________________________________


145
### 0.2.6.29 Release Notes (2019-05-02)
146
147
148

#### Bug fixes

149
- `ShinyGR()` can export the csv table again. It was broken due to modifications to the version 1.2.13.16 of the 'airGR' package
150

151
152
153

#### User-visible changes

154
- it is now possible to export the diagram plot of the model from the `ShinyGR()` interface
155

156
157
158
____________________________________________________________________________________


159
### 0.2.6.27 Release Notes (2019-04-23)
160
161
162
163


#### Bug fixes

164
165
166
167
- `ShinyGR()` may now run for any timezone
- `ShinyGR()` takes into account the fact that on 1 time step `airGR::ErrorCrit_KGE` do not return CritName (temporary patch)
- `ShinyGR()` takes into account the fact that the previous simulation could have a missing value criterion
- `ShinyGR()` takes into account the fact the prevuous Qsim is sometimes to long of one value (temporary patch)
168

169
170
171

#### User-visible changes

172
- the WarmUp element returned by `CalGR()` and `SimGR()` now presents a timezone defined as UTC
173

174
175
176
____________________________________________________________________________________


177
### 0.2.6.14 Release Notes (2019-04-03)
178
179


180
#### User-visible changes
181

182
183
184
- the CemaNeige model is now allowed when the model diagram is drawn in `ShinyGR()`
- `.DiagramGR()` and `.TypeModelGR()` are now private functions
- time format of "Period" and "Event" sliders of the `ShinyGR()` function is now `"%Y-%m-%d"` with the latest versions of the 'shiny' package (like it was with th old versions)
185
186


187
#### CRAN-compatibility updates
188

189
- now depends on the latest version (1.2.13.16) of the 'airGR' package: `CalGR()`, `SimGR()` and `ShinyGR()` have been updated
190
- the 'htmlwidgets' package is no longer imported
191

192
____________________________________________________________________________________
193

194
195

### 0.2.3.2 Release Notes (2018-08-08)
196
197


198
#### User-visible changes
199
200

- the article reference is updated
201
- `.DiagramGR()` no longer returns errors when inputs are not yet available in `ShinyGR()`
202

203
204
205
206
207

#### CRAN-compatibility updates

- now depends on the latest version (1.1.1.6) of the 'dygraphs' package from CRAN (embeded 'dygraphs' functions have been removed)

208
209
210
211
212
213
214
215
____________________________________________________________________________________


### 0.2.2.2 Release Notes (2018-03-21)


#### Bug fixes

216
- bug fixed in `ShinyGR()`, the criteria values are now right on Unix system
217
218


219
#### User-visible changes
220
221
222
223
224
225
226
227
228
229
230

- vignette added

____________________________________________________________________________________


### 0.2.0.9 Release Notes (2018-03-16)


#### CRAN-compatibility updates

231
- embeding 'dygraphs' functions to avoid user to install the last version of this package from GitHub (import of devtools not necessary)
232
233
234
235
236
237
238
239

____________________________________________________________________________________


### 0.1.11.26 Release Notes (2018-02-01)


#### Bug fixes
240
241
- bug fixed in `ShinyGR()` when C1 (or C2) is modified after calibration; the calibration button is now reset
- bug fixed in warm-up, calibration and simulation periods checks in `CalGR()` and `SimGR()` functions
242
243
244
245


#### Deprecated and defunct

246
- `ObsBV` argument has been renamed `ObsDF` in `PrepGR()` and `ShinyGR()` functions
247
248


249
#### User-visible changes
250

251
252
- update and homogenization of the unit of time abbreviation in `.TypeModelGR()` and `ShinyGR()`
- graphical parameters recorded and executed when the `plot.PrepGR()`, `plot.CalGR()` and `plot.SimGR()` functions exit
253
254
255
256
257
258
259
260
261

____________________________________________________________________________________


### 0.1.10.0 Release Notes (2018-01-30)


#### Deprecated and defunct

262
- `ObsGR()` function (and relatives arguments in `CalGR()` and `SimGR()` has been renamed PrepGR()
263
264
265
266
267
268
269
270
271

____________________________________________________________________________________


### 0.1.9.29 Release Notes (2018-01-30)


#### Bug fixes

272
273
274
275
276
277
- missing exchange added on exp. store when plotting GR6J model diagram in `ShinyGR()`
- exp store now appears exported png file of state variables plot in `ShinyGR()` when GR6J is used
- animate button fixed in `ShinyGR()`
- bug fixed in `ShinyGR()` to show previous sim. when model or dataset changes
- bug fixed in `ShinyGR()` to show previous sim. when time window changes but keeps the same length
- bug fixed to disable calibration when there is no Qobs in `ShinyGR()`
278
279
280



281
#### User-visible changes
282

283
284
285
286
287
- it is now possible to draw the model diagram in `ShinyGR()` using the GR6J model
- exp. store now appears in state variables plot in `ShinyGR()` when GR6J is used
- update and homogenization of the unit of time abbreviation in `.TypeModelGR()` and `ShinyGR()`
- write "< - 99.99" in the criteria table of `ShinyGR()` when a criterion is very low
- `ShinyGR()` now allows a list format for `ObsBV` data.frame and CemaNeige inputs
288
289
290
291
292
293
294
295
296

____________________________________________________________________________________


### 0.1.8.14 Release Notes (2017-11-29)


#### Bug fixes

297
298
299
300
- `ObsGR()` function now returns an error if the time zone is not defined as `"UTC"`
- in `ShinyGR()` background color defined to black when the Flatly theme is used
- bug fixed in `ShinyGR()` when inputs are defined in vectors (not in a data.frame)
- Psol et Pliq bars are reversed in `dyplot.default()`
301
302
303



304
#### User-visible changes
305

306
- new reactive to prepare data for plotting in the `ShinyGR()` interface
307
308
309
310
311
312
313

____________________________________________________________________________________


### 0.1.7.6 Release Notes (2017-10-05)


314
#### User-visible changes
315

316
317
318
- `SimGR()` now runs only once to compute all `ErrorCrit`
- it is now possible to show the table of the last simulation criteria in the `ShinyGR()` interface
- it is now possible to export state variable plot from the `ShinyGR()` interface
319
320
321
322
323
324
325
326
327

____________________________________________________________________________________


### 0.1.6.15 Release Notes (2017-09-29)


#### New features

328
- `dyplot()` now allows to draw an additional time series of flow
329
330
331
332


#### Bug fixes

333
334
- bug fixed when zooming after changing snow model on plot to see the last simulation in `ShinyGR()`
- `dyplot()` now plots Pliq and Psol when CemaNeige is used (`dyStackedBarGroup()` instead of the plotter argument)
335
336


337
#### User-visible changes
338

339
340
- disable and enable buttons in `ShinyGR()` interface (using the 'shinyjs' package)
- it is now possible to register the last simulation and draw it on Model diagram of `ShinyGR()`
341
342
343
344
345
346
347
348
349

____________________________________________________________________________________


### 0.1.5.22 Release Notes (2017-09-14)


#### New features

350
351
- it is now possible to export some plots and tables from `ShinyGR()` interface
- in `ShinyGR()`, `TypeModel` inputIds renamed into `HydroModel`
352
353
354
355


#### Bug fixes

356
- period slider is linked to the 'dygraphs' selected period
357
358
359
360


#### Deprecated and defunct

361
- deprecated `Param` arguments in `ShinyGR()`
362

363

364
#### User-visible changes
365
366
367
368
369

- the size of the "Model performance" plot is now adapted if CemaNeige is used or not


#### CRAN-compatibility updates
370

371
- `dyplot()` updated to be compatible with 'dygraphs' >= 1.1.1.4 (available only on GitHub)
372
373
374
375
376
377
378
379
380

____________________________________________________________________________________


### 0.1.4.0 Release Notes (2017-07-21)


#### New features

381
- `ShinyGR()` now use 'dygraphs' devices (except for model perf.)
382
383


384
#### User-visible changes
385

386
- `dyplot.default()` now draws precipitation as a true bar plot and not a step plot
387
388
389
390
391
392
393
394

____________________________________________________________________________________


### 0.1.3.9 Release Notes (2017-06-22)

#### New features

395
- added GR5J in the Model diagram of `ShinyGR()`
396
397
398
399
400
- it is now possible to choose the objective function to calibrate the model


#### Bug fixes

401
- NA values can be drawn by `dyplot*()` functions
402
403
404
405
406
407
408
409
410

____________________________________________________________________________________


### 0.1.2.52 Release Notes (2017-06-02)


#### New features

411
- `shiny.SimGR()` now presents a theme argument that allows to change the stylesheet
412
413
414
415


#### Deprecated and defunct

416
- the `shiny.SimGR()` function has been renamed into `ShinyGR()`
417
418
419
420


#### Bug fixes

421
- bug fixed in `ShinyGR()` to plot state variables with GRJ
422
423


424
#### User-visible changes
425

426
- the `shiny.SimGR()` function has been renamed into `ShinyGR()`
427
428
429
430
431
432
433

____________________________________________________________________________________


### 0.1.1.20 Release Notes (2017-03-21)


434
#### User-visible changes
435

436
437
- in `shiny.SimGR()` if the model diagram is plotted, the animation can be run only from the Event slider and no more from the "Period" slider
- `SimGR()` now also returns the `OptionsCrit` value
438
439
440
441


#### CRAN-compatibility updates

442
- the package now depends on 'airGR' version 1.0.5.22
443
444
445
446
447
448
449
450
451

____________________________________________________________________________________

	 
### 0.0.3.15 Release Notes (2017-01-19)


#### New features

452
453
- it is now possible to calibrate the model in `shiny.SimGR()` and to draw new plots
- `dyplot.default()` gains a `Roller` period argument
454
455
456
457


#### Deprecated and defunct

458
- `TypeModelGR()` is now a private function
459
460
461
462


#### Bug fixes

463
464
- bug fixed, it is now possible to run `CalGR()` with `verbose = FALSE`
- bug fixed in `plot.CalGR()` (it does not use anymore a global variable)