Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 23, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fac0089
docs: note `fetch_*` -> `fetch` breaking change in README.md
lcbrooks May 23, 2023
38f2df6
Bump version
lcbrooks May 23, 2023
045311a
docs: reference 0.6.0 in README.md, change some grammar
lcbrooks May 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]",
Expand Down
2 changes: 1 addition & 1 deletion R/constants.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/"
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down