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



5

6

7
### 0.2.10.106 Release Notes (2021-01-12)
8
9


10
#### New features
11

12
- 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))
13
14


15
#### User-visible changes
16

17
18
- `theme` agument of the `ShinyGR()` function now uses partial matching
- `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))
19
20
21
22
23


#### Version control and issue tracking

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


26
27
#### CRAN-compatibility updates

28
- 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))
29
- now depends on 'airGR' >= 1.6.8.34. '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'
30
- 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))
31

32
33
34
____________________________________________________________________________________


35
### 0.2.9.25 Release Notes (2020-10-19)
36
37
38
39


#### New features

40
- 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))
41
42


43
44
#### Version control and issue tracking

45
- users can now track [changes](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching) and [issues](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/issues)
46
47


48
#### User-visible changes
49

50
- the `theme` agument of the `ShinyGR()` function now works even if a wrong character case is used
51
52
53
54


#### CRAN-compatibility updates

55
- when the package is loaded 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))
56

57
58
59
____________________________________________________________________________________


60
### 0.2.8.69 Release Notes (2020-02-28)
61
62
63
64


#### New features

65
66
67
- 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
68

69
70
71

#### Deprecated and defunct

72
- `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
73

74

75
76
#### Bug fixes

77
- `ShinyGR()` now runs when independent arguments (`DatesR`, `Precip`, etc.) are used instead of the `ObsDF` argument
78
79


80
81
#### User-visible changes

82
83
84
85
86
87
- 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
88
- there is now only one help page for all `plot.*()` functions (use `?plot` to call it)
89

90

91
92
#### CRAN-compatibility updates

93
- 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))
94

95
96
97
____________________________________________________________________________________


98
### 0.2.6.29 Release Notes (2019-05-02)
99
100
101

#### Bug fixes

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

104
105
106

#### User-visible changes

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

109
110
111
____________________________________________________________________________________


112
### 0.2.6.27 Release Notes (2019-04-23)
113
114
115
116


#### Bug fixes

117
118
119
120
- `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)
121

122
123
124

#### User-visible changes

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

127
128
129
____________________________________________________________________________________


130
### 0.2.6.14 Release Notes (2019-04-03)
131
132


133
#### User-visible changes
134

135
136
137
- 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)
138
139


140
#### CRAN-compatibility updates
141

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

145
____________________________________________________________________________________
146

147
148

### 0.2.3.2 Release Notes (2018-08-08)
149
150


151
#### User-visible changes
152
153

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

156
157
158
159
160

#### 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)

161
162
163
164
165
166
167
168
____________________________________________________________________________________


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


#### Bug fixes

169
- bug fixed in `ShinyGR()`, the criteria values are now right on Unix system
170
171


172
#### User-visible changes
173
174
175
176
177
178
179
180
181
182
183

- vignette added

____________________________________________________________________________________


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


#### CRAN-compatibility updates

184
- embeding 'dygraphs' functions to avoid user to install the last version of this package from GitHub (import of devtools not necessary)
185
186
187
188
189
190
191
192

____________________________________________________________________________________


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


#### Bug fixes
193
194
- 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
195
196
197
198


#### Deprecated and defunct

199
- `ObsBV` argument has been renamed `ObsDF` in `PrepGR()` and `ShinyGR()` functions
200
201


202
#### User-visible changes
203

204
205
- 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
206
207
208
209
210
211
212
213
214

____________________________________________________________________________________


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


#### Deprecated and defunct

215
- `ObsGR()` function (and relatives arguments in `CalGR()` and `SimGR()` has been renamed PrepGR()
216
217
218
219
220
221
222
223
224

____________________________________________________________________________________


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


#### Bug fixes

225
226
227
228
229
230
- 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()`
231
232
233



234
#### User-visible changes
235

236
237
238
239
240
- 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
241
242
243
244
245
246
247
248
249

____________________________________________________________________________________


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


#### Bug fixes

250
251
252
253
- `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()`
254
255
256



257
#### User-visible changes
258

259
- new reactive to prepare data for plotting in the `ShinyGR()` interface
260
261
262
263
264
265
266

____________________________________________________________________________________


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


267
#### User-visible changes
268

269
270
271
- `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
272
273
274
275
276
277
278
279
280

____________________________________________________________________________________


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


#### New features

281
- `dyplot()` now allows to draw an additional time series of flow
282
283
284
285


#### Bug fixes

286
287
- 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)
288
289


290
#### User-visible changes
291

292
293
- 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()`
294
295
296
297
298
299
300
301
302

____________________________________________________________________________________


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


#### New features

303
304
- it is now possible to export some plots and tables from `ShinyGR()` interface
- in `ShinyGR()`, `TypeModel` inputIds renamed into `HydroModel`
305
306
307
308


#### Bug fixes

309
- period slider is linked to the 'dygraphs' selected period
310
311
312
313


#### Deprecated and defunct

314
- deprecated `Param` arguments in `ShinyGR()`
315

316

317
#### User-visible changes
318
319
320
321
322

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


#### CRAN-compatibility updates
323

324
- `dyplot()` updated to be compatible with 'dygraphs' >= 1.1.1.4 (available only on GitHub)
325
326
327
328
329
330
331
332
333

____________________________________________________________________________________


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


#### New features

334
- `ShinyGR()` now use 'dygraphs' devices (except for model perf.)
335
336


337
#### User-visible changes
338

339
- `dyplot.default()` now draws precipitation as a true bar plot and not a step plot
340
341
342
343
344
345
346
347

____________________________________________________________________________________


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

#### New features

348
- added GR5J in the Model diagram of `ShinyGR()`
349
350
351
352
353
- it is now possible to choose the objective function to calibrate the model


#### Bug fixes

354
- NA values can be drawn by `dyplot*()` functions
355
356
357
358
359
360
361
362
363

____________________________________________________________________________________


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


#### New features

364
- `shiny.SimGR()` now presents a theme argument that allows to change the stylesheet
365
366
367
368


#### Deprecated and defunct

369
- the `shiny.SimGR()` function has been renamed into `ShinyGR()`
370
371
372
373


#### Bug fixes

374
- bug fixed in `ShinyGR()` to plot state variables with GRJ
375
376


377
#### User-visible changes
378

379
- the `shiny.SimGR()` function has been renamed into `ShinyGR()`
380
381
382
383
384
385
386

____________________________________________________________________________________


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


387
#### User-visible changes
388

389
390
- 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
391
392
393
394


#### CRAN-compatibility updates

395
- the package now depends on 'airGR' version 1.0.5.22
396
397
398
399
400
401
402
403
404

____________________________________________________________________________________

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


#### New features

405
406
- it is now possible to calibrate the model in `shiny.SimGR()` and to draw new plots
- `dyplot.default()` gains a `Roller` period argument
407
408
409
410


#### Deprecated and defunct

411
- `TypeModelGR()` is now a private function
412
413
414
415


#### Bug fixes

416
417
- 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)