R/removeExperiments.R

In BatchExperiments: Statistical Experiments on Batch Computing Clusters

#' @title Remove jobs from registry.
#'
#' @description
#' THIS DELETES ALL FILES REGARDING THE JOBS, INCLUDING RESULTS!
#' If you really know what you are doing, you may set \code{force}
#' to \code{TRUE} to omit sanity checks on running jobs.
#'
#' @param reg [\code{\link{ExperimentRegistry}}]\cr
#'   Registry.
#' @param ids [\code{integer}]\cr
#'   Ids of jobs you want to remove.
#'   Default is none.
#' @param force [\code{logical(1)}]\cr
#'   Also remove jobs which seem to be still running.
#'   Default is \code{FALSE}.
#' @return Vector of type \code{integer} of removed job ids.
#' @family remove
#' @export
removeExperiments = function(reg, ids, force = FALSE) {
  checkExperimentRegistry(reg, strict = TRUE, writeable = TRUE)
  syncRegistry(reg)
  if (missing(ids))
    return(integer(0L))
  ids = checkIds(reg, ids)

  if (!force) {
    cf = getConfig()$cluster.functions
    if(is.null(cf$listJobs) || is.null(cf$killJobs)) {
      stop("Listing or killing of jobs not supported by your cluster functions\n",
           "You need to set force = TRUE to remove jobs, but note the warning in ?removeExperiments")
    }
    running = findRunning(reg, ids)
    if (length(running) > 0L)
      stopf("Can't remove jobs which are still running. You have to kill them first.\nRunning: %s",
            collapse(running))
  }

  info("Removing %i experiments ...", length(ids))
  dbRemoveJobs(reg, ids)

  fmt = "^%i(\\.(R|out)|-result(-.+)*\\.RData)$"
  for (id in ids) {
    fs = list.files(getJobLocation(reg, id), pattern = sprintf(fmt, id), full.names = TRUE)
    ok = file.remove(fs)
    if (!all(ok))
      warningf("Could not remove files for experiment with id=%i", id)
  }

  invisible(ids)
}