Skip to content

Commit ea7e2e8

Browse files
authored
Merge pull request #39 from cmu-delphi/lcb/perform-rename-to-epidatr
Perform package rename from `delphi.epidata` to `epidatr`
2 parents ba8cfe3 + 4c7d7c8 commit ea7e2e8

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Package: delphi.epidata
1+
Package: epidatr
22
Type: Package
33
Title: Client for Delphi's Epidata API
44
Version: 1.0.0
@@ -25,7 +25,7 @@ Imports:
2525
readr,
2626
MMWRweek,
2727
rlang
28-
RoxygenNote: 7.1.1
28+
RoxygenNote: 7.2.1
2929
Suggests:
3030
knitr,
3131
magrittr,

R/delphi-epidata-package.R renamed to R/epidatr-package.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
#' TODO
44
#'
55
#' @docType package
6-
#' @name delphi.epidata
6+
#' @name epidatr
77
NULL

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@
77
Install latest version using [`devtools`](https://cran.r-project.org/package=devtools) package
88

99
```R
10-
devtools::install_github("cmu-delphi/delphi-epidata-r")
10+
devtools::install_github("cmu-delphi/epidatr")
1111
```
1212

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

1820
## Usage
1921

man/delphi.epidata.Rd renamed to man/epidatr.Rd

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/testthat.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
library(testthat)
2-
library(delphi.epidata)
2+
library(epidatr)
33

4-
test_check("delphi.epidata")
4+
test_check("epidatr")

vignettes/covidcast.Rmd

+2-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@ knitr::opts_chunk$set(echo = TRUE)
1616
# Delphi Epidata R API Client
1717

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

vignettes/delphi-epidata.Rmd

+2-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@ knitr::opts_chunk$set(echo = TRUE)
1616
# Delphi Epidata R API Client
1717

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

0 commit comments

Comments
 (0)