R/ds_remove.R

In bernhard-da/datastore: Creates a datastore which can contain versioned datasets

#' ds_remove
#'
#' @param ds path to datastore
#' @param ds_name name of data-object for which a specific version should be removed
#' @param version (number) version of data-object; if \code{NULL}, all versions will be removed
#' @param verbose (logical) if \code{TRUE}, additional messages will be printed to prompt
#' @return \code{NULL}
#' @export
#'
#' @examples
#' ## not yet
ds_remove <- function(ds, ds_name, version=NULL, verbose=TRUE) {
  ds_isvalid(ds)

  stopifnot(is_scalar_character(ds_name), is_scalar_logical(verbose))

  if (!is.null(version)) {
    stopifnot(is_scalar_integerish(version))
  }
  res <- ds_exists(ds, ds_name = ds_name, version = version, verbose = FALSE)
  if (!res) {
    ds_name <- shQuote(substitute(ds_name))
    stop(paste("dataset", ds_name, "does not exist in datastore or required version is not available"), call. = FALSE)
  }

  df <- ds_read_index(ds)$info
  df <- df[df$ds_name == ds_name, , drop = FALSE]
  if (!is.null(version)) {
    df <- df[df$version == version, , drop = FALSE]
  }

  files_to_del <- df$filepath
  res <- file.remove(files_to_del)
  if (!all(res)) {
    stop("some files could not be deleted from datastore")
  }
  if (verbose) {
    message(paste(length(files_to_del), "file(s) successfully deleted from datastore"))
  }
  ds_update_index(ds, verbose = FALSE)
  return(invisible(NULL))
}