R/wp_timeseries_data_to_list.R

In KWB-R/wasserportal: R Package with Functions for Scraping Data of Wasserportal Berlin

#' Wasserportal Time Series Data: download and Import in R List
#'
#' @param overview_list_names names of elements in the list returned by
#'   \code{\link{get_stations}(type = "list")}
#' @param target_dir target directory for downloading data (default:
#' tempdir())
#' @param is_zipped are the data to be downloaded zipped (default:
#' TRUE)
#'
#' @return downloads (zipped) data from wasserportal
#' @export
#' @importFrom archive archive_extract
#' @importFrom fs dir_create
#' @importFrom utils download.file
#' @importFrom readr read_csv
#' @importFrom stringr str_replace str_replace_all
#' @importFrom withr with_dir
#' @examples
#' \dontrun{
#' overview_list_names <- names(wasserportal::get_stations(type = "list"))
#' wp_timeseries_data_list <- wp_timeseries_data_to_list(overview_list_names)
#' }
wp_timeseries_data_to_list <- function(
    overview_list_names,
    target_dir = tempdir(),
    is_zipped = TRUE
)
{
  wp_data_to_list(
    overview_list_names,
    target_dir,
    is_zipped,
    modify_filenames = function(x) {
      is_not_sw_quality <- !grepl("surface-water_quality", x)
      stringr::str_replace_all(x[is_not_sw_quality],
                               "^surface",
                               "daily_surface")
      }
    )
}