R/cluster_spec.R

In kbodwin/celery: What the Package Does (One Line, Title Case)

#' Functions required for celery-adjacent packages
#'
#' These functions are helpful when creating new packages that will register
#' new cluster specifications.
#'
#' @export
#' @keywords internal
#' @rdname add_on_exports
new_cluster_spec <- function(cls, args, eng_args, mode, method, engine) {
  check_spec_mode_engine_val(cls, engine, mode)

  out <- list(
    args = args, eng_args = eng_args,
    mode = mode, method = method, engine = engine
  )
  class(out) <- make_classes_celery(cls)
  out
}

#' Prepend a new class
#'
#' This adds an extra class to a base class of "cluster_spec".
#'
#' @param prefix A character string for a class.
#' @return A character vector.
#' @keywords internal
#' @export
make_classes_celery <- function(prefix) {
  c(prefix, "cluster_spec")
}