R/update_file_repo.R

In cmstillwell/UWparserrr: Helper Functions for UWSMPH Data Analysis

#' Update archive/repository files with most recent versions
#'
#' @param files A vector of (full) paths to the files that will be copied/moved
#' @param destination An atomic vector giving the destination directory
#' @param action File operation (copy or move) to be taken
#' @param overwrite Overwrite files with the same name(s) in the destination directory?
#'
#' @return Nothing. Message displayed upon success
#' @export

update_file_repo <- function(files,
                             destination = getwd(),
                             clear_dest_dir = FALSE,
                             action = "copy",
                             return = "dir",
                             overwrite = FALSE) {
  require(fs)
  require(stringr)

  # Ensure a valid return type is indicated
  assertthat::assert_that(return == "dir" | return == "logical")
  assertthat::assert_that(action == "copy" | action == "move")

  # Manage the destination directory based on the function option

    # No change to directory
    if (clear_dest_dir == FALSE) {
      n.dest.file <-
        dir_ls(destination, type = "file") |>
        length()

      clear.dir.msg <-
        str_glue("{n.dest.file} file(s) already in destination folder:",
                 "'{destination}'. Existing file(s) unaltered.")
    }

    # Delete all files in destination directory
    if (clear_dest_dir) {
      dir_ls(destination, type = "file") |>
      file_delete()

      clear.dir.msg <-
        str_glue("All files in '{destination}' have been deleted.")
    }

    # Delete all files matching the search string as a regular expression
    if (is.character(clear_dest_dir)) {
      dir_ls(destination, regexp = clear_dest_dir) |>
      file_delete()

      clear.dir.msg <-
        str_glue("All files in '{destination}' matching the regular expression ",
                 "'{clear_dest_dir}' have been deleted.")
      }


  # Process input file string of names only it exists (i.e., it has length > 0)

  if (length(files) > 0) {

    dest_path <- path(destination, path_file(files))

    file_copy(files, dest_path, overwrite = overwrite)

    if (action == "move") {
      file_delete(files)
    }

    output_msg <-
      str_glue(clear.dir.msg,
               "{action} operation completed",
               "{length(dest_path)} new file(s) processed.",
               .sep = "; ")
    message(output_msg)

    # set return value and exit function
    return(ifelse(return == "dir", destination, TRUE))
  }

  # Return error when file path argument length = 0.
  if (length(files) == 0) {
    warning(str_glue("No files to {action} because the 'files' argument length is 0."))

    return(ifelse(return == "dir", destination, FALSE))
  }

  }