Skip to content

Perform package rename from delphi.epidata to epidatr #39

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.

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 1 commit into from
Aug 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Package: delphi.epidata
Package: epidatr
Type: Package
Title: Client for Delphi's Epidata API
Version: 1.0.0
Expand All @@ -25,7 +25,7 @@ Imports:
readr,
MMWRweek,
rlang
RoxygenNote: 7.1.1
RoxygenNote: 7.2.1
Suggests:
knitr,
magrittr,
Expand Down
2 changes: 1 addition & 1 deletion R/delphi-epidata-package.R → R/epidatr-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
#' TODO
#'
#' @docType package
#' @name delphi.epidata
#' @name epidatr
NULL
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@
Install latest version using [`devtools`](https://cran.r-project.org/package=devtools) package

```R
devtools::install_github("cmu-delphi/delphi-epidata-r")
devtools::install_github("cmu-delphi/epidatr")
```

Note (2022-08-02): the package that this installs is being renamed from
`delphi.epidata` to `epidatr`. Please adjust all references to the package name
accordingly. For a short-term fix, the package can be used with the old name by
installing with `ref="delphi.epidata-before-rename"`.
`delphi.epidata` to `epidatr`. To migrate, run the installation command above,
followed by `remove.packages("delphi.epidata")`, and adjust all references to
the package name accordingly. For a short-term patch, a snapshot of the package
can be still be installed with the old name by specifying
`ref="delphi.epidata-before-rename"`.

## Usage

Expand Down
6 changes: 3 additions & 3 deletions man/delphi.epidata.Rd → man/epidatr.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions tests/testthat.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
library(testthat)
library(delphi.epidata)
library(epidatr)

test_check("delphi.epidata")
test_check("epidatr")
5 changes: 2 additions & 3 deletions vignettes/covidcast.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ knitr::opts_chunk$set(echo = TRUE)
# Delphi Epidata R API Client

```{r libraries}
# devtools::install_url("https://github.com/cmu-delphi/delphi-epidata-r/releases/latest/download/delphi-epidata.tar.gz")
# install.packages('delphi.epidata')
library('delphi.epidata')
# devtools::install_github('cmu-delphi/epidatr')
library('epidatr')
library('magrittr')
```

Expand Down
5 changes: 2 additions & 3 deletions vignettes/delphi-epidata.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ knitr::opts_chunk$set(echo = TRUE)
# Delphi Epidata R API Client

```{r libraries}
# devtools::install_url("https://github.com/cmu-delphi/delphi-epidata-r/releases/latest/download/delphi-epidata.tar.gz")
# install.packages('delphi.epidata')
library('delphi.epidata')
# devtools::install_github('cmu-delphi/epidatr')
library('epidatr')
library('magrittr')
```

Expand Down