Merge pull request #111 from cmu-delphi/lcb/fetch-readme

docs: note `fetch_*` -> `fetch` breaking change in README.md, bump version

Author: brookslogan

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: epidatr
 Type: Package
 Title: Client for Delphi's Epidata API
-Version: 0.5.0
+Version: 0.6.0
 Authors@R: as.person(c(
   "Jacob Bien <[email protected]> [aut]",
   "Logan Brooks <[email protected]> [aut]",

R/constants.R

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

README.md

@@ -14,6 +14,20 @@ Install latest version using [`remotes`](https://cran.r-project.org/package=remo
 remotes::install_github("cmu-delphi/epidatr")
 ```
 
+Note (2023-05-23): since version 0.6.0, the `fetch_{tbl,classic,df,json,csv}`
+functions have been replaced by the `fetch()` function, which almost always
+returns a tibble, except when used with a limited number of older endpoints
+(such as `delphi()` and `meta()`), where it will output a nested list structure.
+If you encounter an error like
+```{r}
+Error in fetch_tbl(.) : could not find function "fetch_tbl"
+```
+please update to use `fetch()` instead.  If instead you encounter
+```{r}
+Error in fetch(.) : could not find function "fetch"
+```
+please update to the newest `epidatr`.
+
 Note (2022-08-02): the package that this installs is being renamed from
 `delphi.epidata` to `epidatr`. To migrate, run the installation command above,
 followed by `remove.packages("delphi.epidata")`, and adjust all references to