Skip to content

Commit

Permalink
update NEWS for v0.1.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Serena-Wang committed Mar 9, 2021
1 parent c5cbffa commit 67cb211
Showing 1 changed file with 46 additions and 15 deletions.
61 changes: 46 additions & 15 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,51 @@
## Changes since last release
## covidHubUtils 0.1.4

This is a release focusing on updates that provide better interface with Zoltar and European COVID-19 Forecast Hub. The release also contains new feature updates and bug fixes in other util functions.

### Feature updates

- Update `load_forecasts()` and `load_latest_forecasts()`

+ Add `hub` parameter to specify the forecast hub for which data should be loaded.

+ Add `as_of` parameter to improve interface with the Zoltar query.

+ Add `verbose` parameter to specify whether to print out diagnostic messages.

+ Support `source = local_hub_repo` in `load_forecasts()`. However, loading versioned forecast files is only available through zoltar.

+ All models inputed into `load_latest_forecasts()` must be available in the selected `source`.

+ Refactor to improve efficiency.

- Update `plot_forecast()`

+ Load `"inc hosp"` truth data from remote hub repository. The user does not need to provide `truth_data` parameter to plot daily incident hospitalization forecasts.

+ `target_variable` is now optional when `forecast_data` only has one target variable.

+ Add a new parameter `use_median_as_point` that defaults to FALSE. "TRUE" uses the median quantile and "FALSE" uses the point forecasts.

+ The function now errors when trying to plot multiple locations without a facet formula.

+ Fix bug that model legend is missing when the user is only plotting quantile forecasts.

+ Update quantile forecast color so that color transparency will not be overwritten by `fill_transparency` when plotting more than five models.

- Update `load_truth()`

+ Add `hub` parameter to specify the forecast hub for which data should be loaded.

+ Add `"inc hosp"` target variable and `"HealthData"` source.

- add a hub argument to `load_forecasts()`, `load_latest_forecasts()`, `load_latest_forecasts_zoltar()` and `load_truth()` to specify the forecast hub for which data should be loaded.
- `plot_forecast()` now errors when trying to plot multiple locations without a facet formula.
- Fix bug that model legend is missing when the user is only plotting quantile forecasts in `plot_forecast()`. If `forecast_data` doesn't contain point forecasts, the function will look for all available medians in `forecast_data` and plot them as point forecasts.
- Update quantile forecast color so that color transparency will not be overwritten by `fill_transparency` in `plot_forecast()` when plotting more than five models.
- Add optional `as_of` parameter in `get_model_designations()`. Currently only support versioned model designation in local hub repo.
- `target_variable` in `plot_forecast()` now optional when `forecast_data` only has one target variable
- All models inputed into `load_latest_forecasts()` must be available in the source
- `plot_forecast()` has new parameter `use_median_as_point` that defaults to FALSE. "TRUE" uses the median quantile and "FALSE" uses the point forecasts.
- Add the `as_of` parameter to `load_forecasts()`, `load_latest_forecasts()` and `load_latest_forecasts_zoltar()` to improve interface with the Zoltar query.
- `score_forecasts()` has new parameter `use_median_as_point` that defaults to FALSE. "TRUE" uses the median quantile when calculating absolute error and "FALSE" uses the point forecasts for absolute error.
- Add `verbose` parameter to `load_forecasts()` and `load_latest_forecasts()`.
- Refactor `load_latest_forecasts()` and `load_forecasts()` to improve efficiency.
- Support `source = local_hub_repo` in `load_forecasts()`. However, loading versioned forecast files is only available through zoltar.
- Add `"inc hosp"` target variable and `"HealthData"` source to `load_truth()`.
- Load `"inc hosp"` truth data from remote hub repository in `plot_forecast()`. The user does not need to provide `truth_data` parameter to plot daily incident hospitalization forecasts.

- Add optional `as_of` parameter in `get_model_designations()`. Currently only support versioned model designation in local hub repo.

### Package updates
- There is no backwards compatibility.
- Add Nikos I. Bosse and Ariane Stark to author/contributor list
- Add hub_locations_ecde.rda to data folder


## covidHubUtils 0.1.3
Expand Down

0 comments on commit 67cb211

Please sign in to comment.