R/refresh_VirginiaC19.R

In debusklaneml/VirginiaC19: Virginia COVID-19 Related Data

#' Refresh the Virginia COVID-19 Data.
#'
#' @description Updates the Virginia COVID-19 cases.
#'
#' @details This package scrapes the state of Virginia reported cases.
#'
#' @param verbose Should messages be displayed?
#'
#' @source \href{https://github.com/debusklaneml/VirginiaC19}{VirginiaC19}
#' @source \href{https://github.com/Covid19R/documentation}{covid19R documentation}
#'
#' @return A tibble object
#' * date - The date in 'YYYY-MM-DD' format
#' * location - The name of the location as provided by the data source.
#' * location_type - The type of location using the covid19R controlled vocabulary.
#' * location_code - A standardized location code using a national or international standard.
#' * location_code_type The type of standardized location code being used according to the covid19R controlled vocabulary.
#' * data_type - the type of data in that given row using the covid19R controlled vocabulary. Daily totals are found here.
#' * value - number of cases of each data type
#' @export
#'
#' @examples
#' \dontrun{
#' refresh_VirginiaC19()
#' }
#'
refresh_VirginiaC19 <- function(verbose = TRUE) {
  if (verbose) message(glue::glue("Downloading raw data."))

  read_data() %>%
    clean_data()
}