R/deleteTif.R

In ethanplunkett/rasterPrep: Package to prepare raster datasets for analysis or viewing

#' Delete one or more TIFFs and all associated files
#'
#' `deleteTif` deletes the files listed in `x` and all associated files,
#' specifically: \itemize{
#'   \item any file that includes the full name with `.tif` extension and an
#'    additional extension  e.g. `./name.tif.ovr`.
#'   \item a world file which has the same base name but a `.twf` extension
#'   instead of `.tif`
#'   \item if `includeVrt` is `TRUE` a `.vrt` file with the same name.
#' }
#' @param x The path to one or more TIFF files ending in `.tif`.
#' @param includeVrt if `TRUE` (the default) `.vrt` files with the same base
#' name will also be deleted.
#' @return Nothing is returned.
#' @export
deleteTif <- function(x, includeVrt = TRUE) {
  # Delete the target files and any associated files (same name with
  # extensions tacked on) or same base name with ".tfw" instead of ".tif"
  stopifnot(all(grepl("\\.tif$", x, ignore.case = TRUE)))
  for (i in seq_along(x)) {
    targets <- findTifFiles(x[i], includeVrt = includeVrt)
    if (rasterPrepOptions()$verbose)
      cat("Deleting:\n\t\t", paste(targets, collapse = "\n\t\t"), "\n",
          sep = "")
    file.remove(targets)
  }
}