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



5

6

7
### 0.2.10.101 Release Notes (2021-01-04)
8
9


10
#### New features
11

12
- GUI, launched by the <code>ShinyGR()</code> 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
- <code>theme</code> agument of the <code>ShinyGR()</code> function now uses partial matching
18

19
- <code>as.data.frame.airGRt()</code>, <code>plot</code>, <code>plot.PrepGR()</code>, <code>plot.CalGR()</code> and <code>plot.SimGR()</code> functions are no longer exported by the namespace ([#30](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/30))
20
21
22
23
24


#### Version control and issue tracking

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


27
28
#### CRAN-compatibility updates

29
30
- 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))

31
- now depends on 'airGR' >= 1.6.8.24. 'airGRteaching' uses the new 'Ps' output of the <code>RunModel_GR2M</code> function ([#51](https://gitlab.irstea.fr/HYCAR-Hydro/airgr/-/issues/51)) and the new <code>SeriesAggreg()</code> 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'
32

33
34
- 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 <code>dyplot&#42;()</code> and the <code>ShinyGR()</code> functions) ([#5](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/5))

35
36
37
____________________________________________________________________________________


38
### 0.2.9.25 Release Notes (2020-10-19)
39
40
41
42


#### New features

43
- GUI, launched by the <code>ShinyGR()</code> 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))
44
45


46
47
#### Version control and issue tracking

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


51
#### User-visible changes
52

53
- the <code>theme</code> agument of the <code>ShinyGR()</code> function now works even if a wrong character case is used
54
55
56
57


#### CRAN-compatibility updates

58
- when the package is loaded or when the <code>dyplot()</code> and the <code>ShinyGR()</code> 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 <code>dyplot&#42;()</code> and the <code>ShinyGR()</code> functions) ([#5](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/5))
59

60
61
62
____________________________________________________________________________________


63
### 0.2.8.69 Release Notes (2020-02-28)
64
65
66
67


#### New features

68
- added <code>as.data.frame.airGRt()</code> method in order to create a <code>data.frame</code> from outputs of <code>PrepGR()</code>, <code>CalGR()</code> and <code>SimGR()</code> functions. This <code>data.frame</code> 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 <code>NA</code> values (e.g. Qsim with the <code>PrepGR()</code> function)
69

70
- 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 <code>citation("airGRteaching")</code> command
71

72
- two themes of alternative stylesheet are available (<code>"Inrae"</code> and <code>"Saclay"</code>) using the <code>theme</code> agument of the <code>ShinyGR()</code> function
73

74
75
76

#### Deprecated and defunct

77
- <code>CalGR</code> argument is now deprecated in the <code>SimGR()</code> function. It has been replaced by the use of the <code>Param</code> argument which can be set by an object of the class <code>CalGR</code> or by a vector of parameters
78

79

80
81
#### Bug fixes

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


85
86
#### User-visible changes

87
- it is now possible to use the GR4H and GR5H hourly models with or without CemaNeige. For that, in the <code>PrepGR()</code>, the <code>HydroModel</code> argument could be set to <code>"GR4H"</code> or <code>"GR5H"</code>. In the GUI, launched by <code>ShinyGR()</code> 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))
88

89
- it is now possible to run the <code>PrepGR()</code> function when discharge is not provided in <code>Qobs</code>. If it is the case, the <code>CalGR()</code> function will return an error message because it is not possible to calibrate the model. The <code>SimGR()</code> function will return a warning message because it is not possible to compute any efficiency criterion
90

91
92
- it is now possible to run the <code>ShinyGR()</code> function when discharge is not provided in <code>Qobs</code>

93
- when observed discharge is provided in <code>ShinyGR()</code>, the first plotting panel now draws the flow error time series ([#4](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/4))
94

95
- <code>plot()</code> function is now exported
96

97
- <code>dyplot.PrepGR()</code>, <code>dyplot.CalGR()</code> and <code>dyplot.SimGR()</code> functions are no longer exported
98

99
- there is now only one help page for all <code>plot.&#42;()</code> functions (use <code>?plot</code> to call it)
100

101

102
103
#### CRAN-compatibility updates

104
- 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 <code>dyplot&#42;()</code> and the <code>ShinyGR()</code> functions) ([#5](https://gitlab.irstea.fr/HYCAR-Hydro/airgrteaching/-/issues/5))
105

106
107
108
____________________________________________________________________________________


109
### 0.2.6.29 Release Notes (2019-05-02)
110
111
112

#### Bug fixes

113
- <code>ShinyGR()</code> can export the csv table again. It was broken due to modifications to the version 1.2.13.16 of the 'airGR' package
114

115
116
117
118
119

#### User-visible changes

- it is now possible to export the diagram plot of the model from the <code>ShinyGR()</code> interface

120
121
122
____________________________________________________________________________________


123
### 0.2.6.27 Release Notes (2019-04-23)
124
125
126
127


#### Bug fixes

128
- <code>ShinyGR()</code> may now run for any timezone
129

Delaigue Olivier's avatar
Delaigue Olivier committed
130
- <code>ShinyGR()</code> takes into account the fact that on 1 time step <code>airGR::ErrorCrit_KGE</code> do not return CritName (temporary patch)
131

Delaigue Olivier's avatar
Delaigue Olivier committed
132
133
134
- <code>ShinyGR()</code> takes into account the fact that the previous simulation could have a missing value criterion

- <code>ShinyGR()</code> takes into account the fact the prevuous Qsim is sometimes to long of one value (temporary patch)
135

136
137
138

#### User-visible changes

139
- the WarmUp element returned by <code>CalGR()</code> and <code>SimGR()</code> now presents a timezone defined as UTC
140

141
142
143
____________________________________________________________________________________


144
### 0.2.6.14 Release Notes (2019-04-03)
145
146


147
#### User-visible changes
148
149
150

- the CemaNeige model is now allowed when the model diagram is drawn in <code>ShinyGR()</code>

151
- <code>.DiagramGR()</code> and <code>.TypeModelGR()</code> are now private functions
152

153
- time format of "Period" and "Event" sliders of the <code>ShinyGR()</code> function is now <code>"%Y-%m-%d"</code> with the latest versions of the 'shiny' package (like it was with th old versions)
154
155


156
#### CRAN-compatibility updates
157

158
- now depends on the latest version (1.2.13.16) of the 'airGR' package: <code>CalGR()</code>, <code>SimGR()</code> and <code>ShinyGR()</code> have been updated
159

160
- the 'htmlwidgets' package is no longer imported
161

162
____________________________________________________________________________________
163

164
165

### 0.2.3.2 Release Notes (2018-08-08)
166
167


168
#### User-visible changes
169
170
171

- the article reference is updated

172
- <code>.DiagramGR()</code> no longer returns errors when inputs are not yet available in <code>ShinyGR()</code>
173

174
175
176
177
178

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

179
180
181
182
183
184
185
186
187
188
189
____________________________________________________________________________________


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


#### Bug fixes

- bug fixed in <code>ShinyGR()</code>, the criteria values are now right on Unix system


190
#### User-visible changes
191
192
193
194
195
196
197
198
199
200
201

- vignette added

____________________________________________________________________________________


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


#### CRAN-compatibility updates

202
- embeding 'dygraphs' functions to avoid user to install the last version of this package from GitHub (import of devtools not necessary)
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

____________________________________________________________________________________


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


#### Bug fixes
- bug fixed in <code>ShinyGR()</code> 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 <code>CalGR()</code> and <code>SimGR()</code> functions


#### Deprecated and defunct

- <code>ObsBV</code> argument has been renamed <code>ObsDF</code> in <code>PrepGR()</code> and <code>ShinyGR()</code> functions


221
#### User-visible changes
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

- update and homogenization of the unit of time abbreviation in <code>.TypeModelGR()</code> and <code>ShinyGR()</code>

- graphical parameters recorded and executed when the <code>plot.PrepGR()</code>, <code>plot.CalGR()</code> and <code>plot.SimGR()</code> functions exit

____________________________________________________________________________________


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


#### Deprecated and defunct

- <code>ObsGR()</code> function (and relatives arguments in <code>CalGR()</code> and <code>SimGR()</code> has been renamed PrepGR()

____________________________________________________________________________________


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


#### Bug fixes

- missing exchange added on exp. store when plotting GR6J model diagram in <code>ShinyGR()</code>

- exp store now appears exported png file of state variables plot in <code>ShinyGR()</code> when GR6J is used

- animate button fixed in <code>ShinyGR()</code>

- bug fixed in <code>ShinyGR()</code> to show previous sim. when model or dataset changes

- bug fixed in <code>ShinyGR()</code> to show previous sim. when time window changes but keeps the same length

- bug fixed to disable calibration when there is no Qobs in <code>ShinyGR()</code>



259
#### User-visible changes
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

- it is now possible to draw the model diagram in <code>ShinyGR()</code> using the GR6J model

- exp. store now appears in state variables plot in <code>ShinyGR()</code> when GR6J is used

- update and homogenization of the unit of time abbreviation in <code>.TypeModelGR()</code> and <code>ShinyGR()</code>

- write "< - 99.99" in the criteria table of <code>ShinyGR()</code> when a criterion is very low

- <code>ShinyGR()</code> now allows a list format for <code>ObsBV</code> data.frame and CemaNeige inputs

____________________________________________________________________________________


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


#### Bug fixes

- <code>ObsGR()</code> function now returns an error if the time zone is not defined as <code>"UTC"</code>

- in <code>ShinyGR()</code> background color defined to black when the Flatly theme is used

- bug fixed in <code>ShinyGR()</code> when inputs are defined in vectors (not in a data.frame)

- Psol et Pliq bars are reversed in <code>dyplot.default()</code>



289
#### User-visible changes
290
291
292
293
294
295
296
297
298

- new reactive to prepare data for plotting in the <code>ShinyGR()</code> interface

____________________________________________________________________________________


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


299
#### User-visible changes
300
301
302
303
304

- <code>SimGR()</code> now runs only once to compute all <code>ErrorCrit</code>

- it is now possible to show the table of the last simulation criteria in the <code>ShinyGR()</code> interface

305
- it is now possible to export state variable plot from the <code>ShinyGR()</code> interface
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

____________________________________________________________________________________


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


#### New features

- <code>dyplot()</code> now allows to draw an additional time series of flow


#### Bug fixes

- bug fixed when zooming after changing snow model on plot to see the last simulation in <code>ShinyGR()</code>

- <code>dyplot()</code> now plots Pliq and Psol when CemaNeige is used (<code>dyStackedBarGroup()</code> instead of the plotter argument)


325
#### User-visible changes
326

327
- disable and enable buttons in <code>ShinyGR()</code> interface (using the 'shinyjs' package)
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

- it is now possible to register the last simulation and draw it on Model diagram of <code>ShinyGR()</code>

____________________________________________________________________________________


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


#### New features

- it is now possible to export some plots and tables from <code>ShinyGR()</code> interface

- in <code>ShinyGR()</code>, <code>TypeModel</code> inputIds renamed into <code>HydroModel</code>


#### Bug fixes

346
- period slider is linked to the 'dygraphs' selected period
347
348
349
350
351
352


#### Deprecated and defunct

- deprecated <code>Param</code> arguments in <code>ShinyGR()</code>

353

354
#### User-visible changes
355
356
357
358
359

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


#### CRAN-compatibility updates
360

361
- <code>dyplot()</code> updated to be compatible with 'dygraphs' >= 1.1.1.4 (available only on GitHub)
362
363
364
365
366
367
368
369
370

____________________________________________________________________________________


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


#### New features

371
- <code>ShinyGR()</code> now use 'dygraphs' devices (except for model perf.)
372
373


374
#### User-visible changes
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414

- <code>dyplot.default()</code> now draws precipitation as a true bar plot and not a step plot

____________________________________________________________________________________


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

#### New features

- added GR5J in the Model diagram of <code>ShinyGR()</code>

- it is now possible to choose the objective function to calibrate the model


#### Bug fixes

- NA values can be drawn by <code>dyplot*()</code> functions

____________________________________________________________________________________


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


#### New features

- <code>shiny.SimGR()</code> now presents a theme argument that allows to change the stylesheet


#### Deprecated and defunct

- the <code>shiny.SimGR()</code> function has been renamed into <code>ShinyGR()</code>


#### Bug fixes

- bug fixed in <code>ShinyGR()</code> to plot state variables with GRJ


415
#### User-visible changes
416
417
418
419
420
421
422
423
424

- the <code>shiny.SimGR()</code> function has been renamed into <code>ShinyGR()</code>

____________________________________________________________________________________


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


425
#### User-visible changes
426
427
428
429
430
431
432
433

- in <code>shiny.SimGR()</code> if the model diagram is plotted, the animation can be run only from the Event slider and no more from the "Period" slider

- <code>SimGR()</code> now also returns the <code>OptionsCrit</code> value


#### CRAN-compatibility updates

434
- the package now depends on 'airGR' version 1.0.5.22
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458

____________________________________________________________________________________

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


#### New features

- it is now possible to calibrate the model in <code>shiny.SimGR()</code> and to draw new plots

- <code>dyplot.default()</code> gains a <code>Roller</code> period argument


#### Deprecated and defunct

- <code>TypeModelGR()</code> is now a private function


#### Bug fixes

- bug fixed, it is now possible to run <code>CalGR()</code> with <code>verbose = FALSE</code>

- bug fixed in <code>plot.CalGR()</code> (it does not use anymore a global variable)