R/convert.spaces.R

In TAF: Transparent Assessment Framework for Reproducible Research

#' Convert Spaces
#'
#' Convert spaces in filenames.
#'
#' @param file filename, e.g. \code{"file name.csv"}, \code{"*.csv"}, or
#'        \code{"dir/*"}.
#' @param sep character to use instead of spaces.
#'
#' @note
#' This function treats \file{\%20} in filenames as a space and converts to
#' \code{sep}.
#'
#' @return \code{TRUE} for success, \code{FALSE} for failure, invisibly.
#'
#' @seealso
#' \code{\link{file.rename}} is the base function to rename files.
#'
#' \code{\link{TAF-package}} gives an overview of the package.
#'
#' @examples
#' \dontrun{
#' write(pi, "A B.txt")
#' convert.spaces("A B.txt")
#'
#' ## Many files
#' convert.spaces("boot/initial/data/*")
#' }
#'
#' @export

convert.spaces <- function(file, sep="_")
{
  ## Include both glob matches and filenames without asterisk,
  ## in case some filenames without asterisk are not found
  from <- sort(unique(c(Sys.glob(file), file[!grepl("\\*", file)])))
  ## If file is "A B/x y.txt" then convert to "A B/x_y.txt"
  from <- from[grep(" |%20", basename(from))]

  to <- file.path(dirname(from), gsub(" |%20", sep, basename(from)))

  out <- suppressWarnings(mapply(file.rename, from, to))
  if(length(out) == 0)
    out <- NULL

  invisible(out)
}