R/findJobs.R

In tudo-r/BatchJobs: Batch Computing with R

#' Finds ids of jobs that match a query.
#'
#' @template arg_reg
#' @param ids [\code{integer}]\cr
#'   Subset of job ids to restrict the result to.
#'   Default is all jobs.
#' @param pars [R expression]\cr
#'   All jobs whose parameters match the given expression are selected.
#'   This implies that you have named the parameters when you passed the vectors.
#'   If you forgot to do this you can use \code{.arg1}, \code{.arg2}, etc., to refer to the
#'   the unnamed ones.
#' @param jobnames [\code{character}]\cr
#'   Restrict to jobs with stored names. Exact matching is used.
#' @return [\code{integer}]. Ids for jobs which match the query.
#' @export
#' @examples
#' reg = makeRegistry(id = "BatchJobsExample", file.dir = tempfile(), seed = 123)
#' f = function(x, y) x * y
#' batchExpandGrid(reg, f, x = 1:2, y = 1:3)
#' findJobs(reg, pars = (y > 2))
findJobs = function(reg, ids, pars, jobnames) {
  checkRegistry(reg, strict = TRUE, writeable = FALSE)
  syncRegistry(reg)
  if (!missing(ids))
    checkIds(reg, ids)

  if (missing(pars) && missing(jobnames))
    return(getJobIds(reg))

  if (!missing(jobnames)) {
    assertCharacter(jobnames, any.missing = FALSE)
    ids = dbMatchJobNames(reg, ids, jobnames)
  }

  if (!missing(pars)) {
    jobs = dbGetJobs(reg, ids)

    rename = function(pars) {
      ns = names(pars)
      if (is.null(ns)) {
        ns = rep.int("", length(pars))
      }
      j = which(is.na(ns) | ns == "")
      ns[j] = paste0(".arg", seq_along(j))
      setNames(pars, ns)
    }

    ind = vlapply(jobs, function(job, pars, ee) eval(pars, rename(job$pars), ee),
      pars = substitute(pars), ee = parent.frame())
    ids = extractSubList(jobs[!is.na(ind) & ind], "id", element.value = integer(1L))
  }

  ids
}