Rename exported objects 'MPI' and 'PSOCK' to 'RMPI' and 'RPSOCK'

Author: HenrikBengtsson

NAMESPACE

@@ -29,8 +29,8 @@ S3method(print,RichSOCKnode)
 S3method(stopCluster,RichMPIcluster)
 S3method(summary,RichSOCKcluster)
 S3method(summary,RichSOCKnode)
-export(MPI)
-export(PSOCK)
+export(RMPI)
+export(RPSOCK)
 export(as.cluster)
 export(autoStopCluster)
 export(availableConnections)

NEWS.md

@@ -6,6 +6,16 @@
    This means that as soon as it has been called, environment variables 
    such as `NSLOTS` will no longer be queried.
 
+ * Starting with R 4.5.0 (currently R-devel), one can use
+   `parallel::makeCluster(n, type = parallelly::RPSOCK)` as an
+   alternative to `parallelly::makeClusterPSOCK(n)`.  Similarly, `type
+   = parallelly::RMPI` creates a cluster using
+   `parallelly::makeClusterMPI()`, and `type = parallelly::SEQ`
+   creates a cluster using `parallelly::makeClusterSequential()`.
+   This was first introduced in **parallelly** 1.38.0, but here we rename
+   `PSOCK` to `RPSOCK` and `MPI` to `RMPI` to minimize the risk for
+   mistaking them from the built-in types in the **parallel** package.
+
 ## Documentation
 
  * Add more help on the R option `parallelly.maxWorkers.localhost`

R/makeClusterMPI.R

@@ -1,4 +1,4 @@
-#' Create a Message Passing Interface (MPI) Cluster of R Workers for Parallel Processing
+#' Create a Rich Message Passing Interface (MPI) Cluster of R Workers for Parallel Processing
 #' 
 #' The `makeClusterMPI()` function creates an MPI cluster of \R workers
 #' for parallel processing.  This function utilizes 
@@ -47,7 +47,7 @@
 #' @seealso
 #' [makeClusterPSOCK()] and [parallel::makeCluster()].
 #'
-#' @aliases MPI
+#' @aliases RMPI
 #' @importFrom parallel makeCluster
 #' @export
 makeClusterMPI <- function(workers, ..., autoStop = FALSE, verbose = getOption2("parallelly.debug", FALSE)) {

R/makeClusterPSOCK.R

@@ -1,4 +1,4 @@
-#' Create a PSOCK Cluster of R Workers for Parallel Processing
+#' Create a Rich PSOCK Cluster of R Workers for Parallel Processing
 #' 
 #' The `makeClusterPSOCK()` function creates a cluster of \R workers
 #' for parallel processing.  These \R workers may be background \R sessions
@@ -128,7 +128,7 @@
 #'
 #' @example incl/makeClusterPSOCK.R
 #'
-#' @aliases PSOCK
+#' @aliases RPSOCK
 #' @importFrom parallel stopCluster
 #' @export
 makeClusterPSOCK <- function(workers, makeNode = makeNodePSOCK, port = c("auto", "random"), user = NULL, ..., autoStop = FALSE, tries = getOption2("parallelly.makeNodePSOCK.tries", 3L), delay = getOption2("parallelly.makeNodePSOCK.tries.delay", 15.0), validate = getOption2("parallelly.makeNodePSOCK.validate", TRUE), verbose = getOption2("parallelly.debug", FALSE)) {

R/registerClusterTypes.R

@@ -1,12 +1,12 @@
 ## Register makeClusterMPI() and makeClusterPSOCK() as a cluster types
 ## such that they can be created using parallel::makeCluster(), e.g.
-## cl <- parallel::makeCluster(..., type = parallelly::PSOCK)
+## cl <- parallel::makeCluster(..., type = parallelly::RPSOCK)
 
-#' @rawNamespace export(MPI)
-MPI   <- "parallelly::MPI"
+#' @rawNamespace export(RMPI)
+RMPI   <- "parallelly::RMPI"
 
-#' @rawNamespace export(PSOCK)
-PSOCK <- "parallelly::PSOCK"
+#' @rawNamespace export(RPSOCK)
+RPSOCK <- "parallelly::RPSOCK"
 
 #' @rawNamespace if (getRversion() >= "4.4") export(SEQ)
 SEQ <- "parallelly::SEQ"
@@ -26,9 +26,9 @@ registerClusterTypes <- local({
     ## WORKAROUND: 'R CMD build' somehow creates and calls this function
     ## twice, resulting in warnings from parallel::registerClusterType().
     suppressWarnings({
-      registerClusterType(MPI,   makeClusterMPI,        make.default = FALSE)
-      registerClusterType(PSOCK, makeClusterPSOCK,      make.default = FALSE)
-      registerClusterType(SEQ,   makeClusterSequential, make.default = FALSE)
+      registerClusterType(RMPI,   makeClusterMPI,        make.default = FALSE)
+      registerClusterType(RPSOCK, makeClusterPSOCK,      make.default = FALSE)
+      registerClusterType(SEQ,    makeClusterSequential, make.default = FALSE)
     })
     done <<- TRUE
   }