From fac0089ca3605d0407be7aa6c2060bb5e8ea08b1 Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Tue, 23 May 2023 11:20:49 -0700 Subject: [PATCH 1/3] docs: note `fetch_*` -> `fetch` breaking change in README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 4f202367..13d8dbbd 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,19 @@ Install latest version using [`remotes`](https://cran.r-project.org/package=remo remotes::install_github("cmu-delphi/epidatr") ``` +Note (2023-05-23): the `fetch_{tbl,classic,df,json,csv}` functions have been +replaced by the `fetch()` function, which returns a tibble except for a few +older endpoints, which 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 From 38f2df63ee82b96f68982bd1f64c7f3b79f35974 Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Tue, 23 May 2023 11:24:34 -0700 Subject: [PATCH 2/3] Bump version --- DESCRIPTION | 2 +- R/constants.R | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 85f7a638..ddba9cce 100644 --- a/DESCRIPTION +++ b/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 [aut]", "Logan Brooks [aut]", diff --git a/R/constants.R b/R/constants.R index 92996702..0af17729 100644 --- a/R/constants.R +++ b/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/" From 045311a7cc2b20944454fb06364501a07407447d Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Tue, 23 May 2023 11:30:07 -0700 Subject: [PATCH 3/3] docs: reference 0.6.0 in README.md, change some grammar --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 13d8dbbd..3755c208 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,11 @@ Install latest version using [`remotes`](https://cran.r-project.org/package=remo remotes::install_github("cmu-delphi/epidatr") ``` -Note (2023-05-23): the `fetch_{tbl,classic,df,json,csv}` functions have been -replaced by the `fetch()` function, which returns a tibble except for a few -older endpoints, which will output a nested list structure. If you encounter an -error like +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" ```