diff --git a/DESCRIPTION b/DESCRIPTION index d96b2f1f..7675ec1f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,4 +1,4 @@ -Package: delphi.epidata +Package: epidatr Type: Package Title: Client for Delphi's Epidata API Version: 1.0.0 @@ -25,7 +25,7 @@ Imports: readr, MMWRweek, rlang -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.1 Suggests: knitr, magrittr, diff --git a/R/delphi-epidata-package.R b/R/epidatr-package.R similarity index 70% rename from R/delphi-epidata-package.R rename to R/epidatr-package.R index 398475b6..40d61673 100644 --- a/R/delphi-epidata-package.R +++ b/R/epidatr-package.R @@ -3,5 +3,5 @@ #' TODO #' #' @docType package -#' @name delphi.epidata +#' @name epidatr NULL diff --git a/README.md b/README.md index ef729f01..2efa5d84 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/man/delphi.epidata.Rd b/man/epidatr.Rd similarity index 50% rename from man/delphi.epidata.Rd rename to man/epidatr.Rd index 943109ac..b71cbe70 100644 --- a/man/delphi.epidata.Rd +++ b/man/epidatr.Rd @@ -1,8 +1,8 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/delphi-epidata-package.R +% Please edit documentation in R/epidatr-package.R \docType{package} -\name{delphi.epidata} -\alias{delphi.epidata} +\name{epidatr} +\alias{epidatr} \title{Delphi Epidata} \description{ TODO diff --git a/tests/testthat.R b/tests/testthat.R index 5ec283f2..22ea0e9a 100644 --- a/tests/testthat.R +++ b/tests/testthat.R @@ -1,4 +1,4 @@ library(testthat) -library(delphi.epidata) +library(epidatr) -test_check("delphi.epidata") +test_check("epidatr") diff --git a/vignettes/covidcast.Rmd b/vignettes/covidcast.Rmd index 23160de7..e2630060 100644 --- a/vignettes/covidcast.Rmd +++ b/vignettes/covidcast.Rmd @@ -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') ``` diff --git a/vignettes/delphi-epidata.Rmd b/vignettes/delphi-epidata.Rmd index 97417c1f..8ee4dc50 100644 --- a/vignettes/delphi-epidata.Rmd +++ b/vignettes/delphi-epidata.Rmd @@ -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') ```