Merge pull request #228 from cmu-delphi/ndefries/doc-changelog

Describe recent bug fix, small documentation changes

Author: nmdefries

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.0
+current_version = 1.0.0.9000
 commit = False
 tag = False
 

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: epidatr
 Type: Package
 Title: Client for Delphi's 'Epidata' API
-Version: 1.1.0.9000
-Date: 2023-09-11
+Version: 1.0.0.9000
+Date: 2023-12-07
 Authors@R:
   c(
     person("Logan", "Brooks", email = "lcbrooks@andrew.cmu.edu", role = c("aut")),

NEWS.md

@@ -1,9 +1,25 @@
-# epidatr 1.1.0
+# epidatr 1.0.0.9000
 
-- renamed the mostly internal `get_auth_key` to `get_api_key`
-- added `save_api_key` to more easily set the option
-- various CRAN submission related doc-fixes
-- fixed some errors from passing "" as a key
+- Function reference now displays commonly-used functions first (#205).
+- Endpoints now fail when passed misspelled arguments (#187, #201).
+- `pub_fluview_meta` fixed to `fetch` the response automatically.
+- `pub_covid_hosp_state_timeseries` now supports use of the `as_of` parameter (#209).
+- `pub_covid_hosp_state_timeseries` now correctly parses the `issue` field,
+  instead of returning a missing value (#202).
+- `release_date` and `latest_update` fields are now parsed as `Date`, rather
+  than as text. This change impacts several endpoints..
+- In `pub_fluview_meta`, `latest_issue` field is now parsed as epiweek, rather
+  than being parsed as `Date` and returning a missing value.
+- Support `Date` objects passed to version arguments `as_of` and `issues` in
+  endpoints (#192, #194).
+- `set_cache` cache size no longer runs into integer overflow (#189).
+- `clear_cache` now handles positional arguments just like `set_cache` (#197).
+- Improve line-wrapping of warning messages (#191).
+- `set_api_key` now available to help persist API key environment variables (#181, #217).
+- `get_auth_key` renamed to `get_api_key` (#181).
+- `get_api_key` no longer reads from R options and only uses environment variables (#217).
+- Fix documentation related to CRAN submission.
+- Fix some errors from passing "" as a key.
 
 # epidatr 1.0.0
 

R/constants.R

@@ -1,3 +1,3 @@
-version <- "1.1.0"
+version <- "1.0.0.9000"
 http_headers <- httr::add_headers("User-Agent" = paste0("epidatr/", version), "Accept-Encoding" = "gzip")
 global_base_url <- "https://api.delphi.cmu.edu/epidata/"