From 2c01032eda29adb5c8b725b534a5dad410dd34cc Mon Sep 17 00:00:00 2001 From: Dillon Mahmoudi Date: Wed, 15 Nov 2023 20:42:50 -0500 Subject: [PATCH] Update to \donttest & cache messages --- R/lehdr.R | 13 +++++++------ man/grab_lodes.Rd | 2 +- vignettes/getting_started.Rmd | 1 - 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/lehdr.R b/R/lehdr.R index d9a4dc0..0203508 100644 --- a/R/lehdr.R +++ b/R/lehdr.R @@ -50,7 +50,7 @@ #' @importFrom stringr str_sub str_extract #' #' @examples -#' \dontrun{ +#' \donttest{ #' # download and load 2014 block level O-D data for Oregon #' blk_df_or_od <- grab_lodes(state = 'or', year = 2014, lodes_type = "od", job_type = "JT01", #' segment = "SA01", state_part = "main") @@ -161,23 +161,24 @@ grab_lodes <- function(state, year, if(use_cache) { # User set use_cache to TRUE # If there is a cache, use it if(file.exists(fil)) { - message(glue::glue("Cached version of file found in {fil}\n Reading now...")) + message(glue::glue("Cached version of file found in: {fil}")) } else { - message(glue::glue("Downloading {url} to {fil} now...")) + message(glue::glue("Downloading {url} to cache folder: {fil}")) res <- httr::GET(url, httr::write_disk(fil)) + message(glue::glue("Download complete.")) } } else { # User did not allow cache to be used if(file.exists(fil)) { # Existing file found, inform user of use_cache - message(glue::glue("Cached version of file found in {fil}.")) + message(glue::glue("Cached version of file found in: {fil}")) message(glue::glue("Consider setting use_cache=TRUE to use previously downloaded files.")) - message(glue::glue("Overwriting {url} to {fil} now...")) } else { # No file found, inform user that we're downloading - message(glue::glue("Downloading {url} to {fil} now...")) } # Download (and overwite if necessary) data from server + message(glue::glue("Overwriting {url} to {fil} now...")) res <- httr::GET(url, httr::write_disk(fil, overwrite = TRUE)) + message(glue::glue("Overwrite complete.")) } # Read in the data diff --git a/man/grab_lodes.Rd b/man/grab_lodes.Rd index 8622624..80a4495 100644 --- a/man/grab_lodes.Rd +++ b/man/grab_lodes.Rd @@ -74,7 +74,7 @@ a dataframe (tibble) of block or tract level LODES files Download LODES OD, RAC, and WAC tables } \examples{ -\dontrun{ +\donttest{ # download and load 2014 block level O-D data for Oregon blk_df_or_od <- grab_lodes(state = 'or', year = 2014, lodes_type = "od", job_type = "JT01", segment = "SA01", state_part = "main") diff --git a/vignettes/getting_started.Rmd b/vignettes/getting_started.Rmd index 730c953..8c404f4 100644 --- a/vignettes/getting_started.Rmd +++ b/vignettes/getting_started.Rmd @@ -53,7 +53,6 @@ library(stringr) This first example pulls the Oregon (`state = "or"`) 2020 (`year = 2020`) from LODES version 8 (`version="LODES8"`, default), origin-destination (`lodes_type = "od"`), all jobs including private primary, secondary, and Federal (`job_type = "JT01"`, default), all jobs across ages, earnings, and industry (`segment = "S000"`, default), aggregated at the Census Tract level rather than the default Census Block (`agg_geo = "tract"`). ```{r usage1, eval=FALSE} - or_od <- grab_lodes(state = "or", year = 2020, version = "LODES8",