export function

NAMESPACE

@@ -46,6 +46,7 @@ export(aggregate_simulations)
 export(bias)
 export(bootPredict)
 export(boot_predict)
+export(clusterSetRNGSubStream)
 export(colSDs)
 export(colVars)
 export(createDesign)

R/util.R

@@ -695,6 +695,22 @@ set_seed <- function(seed){
 
 recvResult_fun <- utils::getFromNamespace("recvResult", "snow")
 
+#' Set RNG sub-stream for  Pierre L'Ecuyer's RngStreams
+#'
+#' Sets the sub-stream RNG state within for Pierre L'Ecuyer's (1999)
+#' algorithm. Should be used within distributed array jobs
+#' after suitable L'Ecuyer's (1999) have been distributed to each array, and
+#' each array is further defined to use multi-core processing. See
+#' \code{\link[parallel]{clusterSetRNGStream}} for further information.
+#'
+#' @param seed An integer vector of length 7 as given by \code{.Random.seed} when
+#'   the L'Ecuyer-CMR RNG is in use. See\code{\link{RNG}} for the valid values
+#' @param cl A cluster from the \code{parallel} or \code{snow} package, or
+#'   (if \code{NULL}) the registered cluster
+#' @return invisible NULL
+#' @export
+#'
+#'
 clusterSetRNGSubStream <- function(cl, seed){
     nc <- length(cl)
     seeds <- vector("list", nc)