R/000.re-exports.R

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

#' Functions Moved to 'parallelly'
#'
#' The following function used to be part of \pkg{future} but has since
#' been migrated to \pkg{parallelly}.  The migration started with
#' \pkg{future} 1.20.0 (November 2020).  They were moved because they
#' are also useful outside of the \pkg{future} framework.
#'
#' _If you are using any of these from the \pkg{future} package, please
#'  switch to use the ones from the \pkg{parallelly} package. Thank you!_
#'
#' * [parallelly::as.cluster()]
#    Used by: googleComputeEngineR(2)
#' * [parallelly::autoStopCluster()]   (no longer re-exported)
#    Used by: <none>
#' * [parallelly::availableCores()]
#    Used by: aroma.affymetrix(2,3), ARPALData, BatchGetSymbols,
#             bistablehistory, codalm, crossmap, cft, CSCNet, deseats,
#             dipsaus, drimmR, elevatr, foieGras(4), future.BatchJobs(4),
#             future.callr(2), GetBCBData, gtfs2emis, heterogen, isoreader,
#             ItemResponseTrees, ldaPrototype, lidR, meedr, microservices,
#             microsynth, origami, PINstimation, powRICLPM, rBiasCorrection,
#             readsdr, recforest, rkeops, sigminer, skpr, smoots, sovereign,
#             TriDimRegression, uci, updog, whitewater, yfR
#' * [parallelly::availableWorkers()]
#    Used by: aroma.affymetrix(2,3), wqspt(1)
#' * [parallelly::makeClusterMPI()]    (no longer re-exported)
#    Used by: <none>
#' * [parallelly::makeClusterPSOCK()]
#    Used by: bigDM(1), eatRep, fect, foieGras(4), googleComputeEngineR(2),
#             gsynth, interflex, ivDiag
#' * [parallelly::makeNodePSOCK()]     (no longer re-exported)
#    Used by: <none>
#' * [parallelly::supportsMulticore()]
#    Used by: crossmap, dhReg, furrr(1), microservices, sctransform
#
#  (1) PR sent
#  (2) In the next release
#  (3) Non-breaking; code is never run
#  (4) No longer on CRAN
#' 
#' For backward-compatible reasons, _some_ of these functions remain
#' available as exact copies also from this package (as re-exports), e.g.
#'
#' ```r
#' cl <- parallelly::makeClusterPSOCK(2)
#' ```
#'
#' can still be accessed as:
#'
#' ```r
#' cl <- future::makeClusterPSOCK(2)
#' ```
#'
#' _Note that it is the goal to remove all of the above from this package._
#'
#'
#' @importFrom parallelly as.cluster
#' @export as.cluster
#' @aliases as.cluster
#'
#' @importFrom parallelly availableCores
#' @export availableCores
#' @aliases availableCores
#'
#' @importFrom parallelly availableWorkers
#' @export availableWorkers
#' @aliases availableWorkers
#'
#' @importFrom parallelly makeClusterPSOCK
#' @export makeClusterPSOCK
#' @aliases makeClusterPSOCK
#'
#' @importFrom parallelly supportsMulticore
#' @export supportsMulticore
#' @aliases supportsMulticore
#'
#' @name re-exports
#' @keywords internal
NULL