R/export_list.R

In medpsytuebingen/medpsytueR: Common Functions Used At The Medical Psychology Tuebingen

#' Export a list of data frames
#'
#' @param list a list of data frames.
#' @param folder the path to destination.
#' @param format the format in which to save the data. Currently only "rds"
#'     and "csv" (Default)are available.
#'
#' @return RDS or CSV files for each data frame in the list.
#' @export
#'
export_list <- function(list, folder = NULL, format = "csv") {
  if (!(is.list(list))) {
    stop(paste(list, " is not a list, and I cannot export it"))
  }

  if (is.null(folder)) {
    stop("Please provide a path to where you want to export the list")
  }

  if (!(format %in% c("rds", "csv"))) {
    stop(paste(format, "is not a valid format, or not yet implemented."))
  }

  switch(
    format,
    rds = purrr::iwalk(
      list,
      ~ readr::write_rds(.x, path = paste0(folder, .y, ".rds"))
    ),
    csv = purrr::iwalk(
      list,
      ~ readr::write_csv(.x, path = paste0(folder, .y, ".csv"))
    )
  )

  # success!!!
  print(paste(length(list), "tables exported!"))
}