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



5

6

7
### 0.2.10.112 Release Notes (2021-01-23)
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
16
17
18
19
#### Bug fixes

- Fix `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))


20
#### User-visible changes
21

22
- `theme` agument of the `ShinyGR()` function now uses partial matching ([#12](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/12))
23
- `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))
24
25
26
27
28


#### Version control and issue tracking

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


31
32
#### CRAN-compatibility updates

33
- 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))
34
- 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'
35
- 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))
36

37
38
39
____________________________________________________________________________________


40
### 0.2.9.25 Release Notes (2020-10-19)
41
42
43
44


#### New features

45
- 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))
46
47


48
49
#### Version control and issue tracking

50
- users can now track [changes](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching) and [issues](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/issues)
51
52


53
#### User-visible changes
54

55
- the `theme` agument of the `ShinyGR()` function now works even if a wrong character case is used
56
57
58
59


#### CRAN-compatibility updates

60
- 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))
61

62
63
64
____________________________________________________________________________________


65
### 0.2.8.69 Release Notes (2020-02-28)
66
67
68
69


#### New features

70
71
72
- 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
73

74
75
76

#### Deprecated and defunct

77
- `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
78

79

80
81
#### Bug fixes

82
- `ShinyGR()` now runs when independent arguments (`DatesR`, `Precip`, etc.) are used instead of the `ObsDF` argument
83
84


85
86
#### User-visible changes

87
88
89
90
91
92
- 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
93
- there is now only one help page for all `plot.*()` functions (use `?plot` to call it)
94

95

96
97
#### CRAN-compatibility updates

98
- 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))
99

100
101
102
____________________________________________________________________________________


103
### 0.2.6.29 Release Notes (2019-05-02)
104
105
106

#### Bug fixes

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

109
110
111

#### User-visible changes

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

114
115
116
____________________________________________________________________________________


117
### 0.2.6.27 Release Notes (2019-04-23)
118
119
120
121


#### Bug fixes

122
123
124
125
- `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)
126

127
128
129

#### User-visible changes

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

132
133
134
____________________________________________________________________________________


135
### 0.2.6.14 Release Notes (2019-04-03)
136
137


138
#### User-visible changes
139

140
141
142
- 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)
143
144


145
#### CRAN-compatibility updates
146

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

150
____________________________________________________________________________________
151

152
153

### 0.2.3.2 Release Notes (2018-08-08)
154
155


156
#### User-visible changes
157
158

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

161
162
163
164
165

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

166
167
168
169
170
171
172
173
____________________________________________________________________________________


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


#### Bug fixes

174
- bug fixed in `ShinyGR()`, the criteria values are now right on Unix system
175
176


177
#### User-visible changes
178
179
180
181
182
183
184
185
186
187
188

- vignette added

____________________________________________________________________________________


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


#### CRAN-compatibility updates

189
- embeding 'dygraphs' functions to avoid user to install the last version of this package from GitHub (import of devtools not necessary)
190
191
192
193
194
195
196
197

____________________________________________________________________________________


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


#### Bug fixes
198
199
- 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
200
201
202
203


#### Deprecated and defunct

204
- `ObsBV` argument has been renamed `ObsDF` in `PrepGR()` and `ShinyGR()` functions
205
206


207
#### User-visible changes
208

209
210
- 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
211
212
213
214
215
216
217
218
219

____________________________________________________________________________________


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


#### Deprecated and defunct

220
- `ObsGR()` function (and relatives arguments in `CalGR()` and `SimGR()` has been renamed PrepGR()
221
222
223
224
225
226
227
228
229

____________________________________________________________________________________


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


#### Bug fixes

230
231
232
233
234
235
- 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()`
236
237
238



239
#### User-visible changes
240

241
242
243
244
245
- 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
246
247
248
249
250
251
252
253
254

____________________________________________________________________________________


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


#### Bug fixes

255
256
257
258
- `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()`
259
260
261



262
#### User-visible changes
263

264
- new reactive to prepare data for plotting in the `ShinyGR()` interface
265
266
267
268
269
270
271

____________________________________________________________________________________


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


272
#### User-visible changes
273

274
275
276
- `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
277
278
279
280
281
282
283
284
285

____________________________________________________________________________________


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


#### New features

286
- `dyplot()` now allows to draw an additional time series of flow
287
288
289
290


#### Bug fixes

291
292
- 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)
293
294


295
#### User-visible changes
296

297
298
- 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()`
299
300
301
302
303
304
305
306
307

____________________________________________________________________________________


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


#### New features

308
309
- it is now possible to export some plots and tables from `ShinyGR()` interface
- in `ShinyGR()`, `TypeModel` inputIds renamed into `HydroModel`
310
311
312
313


#### Bug fixes

314
- period slider is linked to the 'dygraphs' selected period
315
316
317
318


#### Deprecated and defunct

319
- deprecated `Param` arguments in `ShinyGR()`
320

321

322
#### User-visible changes
323
324
325
326
327

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


#### CRAN-compatibility updates
328

329
- `dyplot()` updated to be compatible with 'dygraphs' >= 1.1.1.4 (available only on GitHub)
330
331
332
333
334
335
336
337
338

____________________________________________________________________________________


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


#### New features

339
- `ShinyGR()` now use 'dygraphs' devices (except for model perf.)
340
341


342
#### User-visible changes
343

344
- `dyplot.default()` now draws precipitation as a true bar plot and not a step plot
345
346
347
348
349
350
351
352

____________________________________________________________________________________


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

#### New features

353
- added GR5J in the Model diagram of `ShinyGR()`
354
355
356
357
358
- it is now possible to choose the objective function to calibrate the model


#### Bug fixes

359
- NA values can be drawn by `dyplot*()` functions
360
361
362
363
364
365
366
367
368

____________________________________________________________________________________


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


#### New features

369
- `shiny.SimGR()` now presents a theme argument that allows to change the stylesheet
370
371
372
373


#### Deprecated and defunct

374
- the `shiny.SimGR()` function has been renamed into `ShinyGR()`
375
376
377
378


#### Bug fixes

379
- bug fixed in `ShinyGR()` to plot state variables with GRJ
380
381


382
#### User-visible changes
383

384
- the `shiny.SimGR()` function has been renamed into `ShinyGR()`
385
386
387
388
389
390
391

____________________________________________________________________________________


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


392
#### User-visible changes
393

394
395
- 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
396
397
398
399


#### CRAN-compatibility updates

400
- the package now depends on 'airGR' version 1.0.5.22
401
402
403
404
405
406
407
408
409

____________________________________________________________________________________

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


#### New features

410
411
- it is now possible to calibrate the model in `shiny.SimGR()` and to draw new plots
- `dyplot.default()` gains a `Roller` period argument
412
413
414
415


#### Deprecated and defunct

416
- `TypeModelGR()` is now a private function
417
418
419
420


#### Bug fixes

421
422
- 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)