R/utils-registerClusterTypes.R

In future: Unified Parallel and Distributed Processing in R for Everyone

## Register makeClusterMPI() and makeClusterPSOCK() as a cluster types
## such that they can be created using parallel::makeCluster(), e.g.
## cl <- parallel::makeCluster(..., type = parallelly::RPSOCK)

#' @rawNamespace if (getRversion() >= "4.4") export(FUTURE)
FUTURE <- "future::FUTURE"

registerClusterTypes <- local({
  done <- FALSE
  
  function() {
    if (done) return()
    
    ns <- getNamespace("parallel")
    ## Only available in R (>= 4.5.0)
    if (!exists("registerClusterType", envir = ns)) return()
    
    registerClusterType <- get("registerClusterType", envir = ns)

    ## WORKAROUND: 'R CMD build' somehow creates and calls this function
    ## twice, resulting in warnings from parallel::registerClusterType().
    suppressWarnings({
      registerClusterType(FUTURE, makeClusterFuture, make.default = FALSE)
    })
    done <<- TRUE
  }
})