Update docs for some cases of missed cluster_config() (#386)

* Update parallel vignette for omission found in #382

* Also make update in main `make_cluster()` docs

Author: shikokuchuo

R/parallel.R

@@ -16,9 +16,10 @@
 #'   connections, e.g. 'tcp://10.75.37.40:5555'. Specify a URL with the scheme
 #'   'tls+tcp://' to use secure TLS connections.
 #' @param remote \[default NULL\] (specify to launch remote nodes) a remote
-#'   launch configuration generated by [remote_config()] or [ssh_config()]. If
-#'   not supplied, nodes may be deployed manually on remote resources.
-#' @param ... additional arguments passed onto [daemons()].
+#'   launch configuration generated by [ssh_config()], [cluster_config()] or
+#'   [remote_config()]. If not supplied, nodes may be deployed manually on
+#'   remote resources.
+#' @param ... additional arguments passed to [daemons()].
 #'
 #' @return For **make_cluster**: An object of class 'miraiCluster' and
 #'   'cluster'. Each 'miraiCluster' has an automatically assigned ID and `n`

dev/vignettes/_v04-parallel.Rmd

@@ -25,7 +25,7 @@ This function calls `make_cluster()`, which may also be used to create a 'miraiC
 
   + Specify 'n' to launch nodes on the local machine.
   + Specify 'url' for receiving connections from remote nodes.
-  + Optionally, specify 'remote' to launch remote daemons using a remote configuration generated by `remote_config()` or `ssh_config()`.
+  + Optionally, specify 'remote' to launch remote daemons using a remote configuration generated by `ssh_config()`, `cluster_config` or `remote_config()`.
 
 Created clusters may be used for any function in the `parallel` base package such as `parallel::clusterApply()` or `parallel::parLapply()`, or the load-balanced versions such as `parallel::parLapplyLB()`.
 ```{r}

man/make_cluster.Rd

@@ -18,7 +18,7 @@ This function calls `make_cluster()`, which may also be used to create a 'miraiC
 
   + Specify 'n' to launch nodes on the local machine.
   + Specify 'url' for receiving connections from remote nodes.
-  + Optionally, specify 'remote' to launch remote daemons using a remote configuration generated by `remote_config()` or `ssh_config()`.
+  + Optionally, specify 'remote' to launch remote daemons using a remote configuration generated by `ssh_config()`, `cluster_config` or `remote_config()`.
 
 Created clusters may be used for any function in the `parallel` base package such as `parallel::clusterApply()` or `parallel::parLapply()`, or the load-balanced versions such as `parallel::parLapplyLB()`.
 
@@ -28,7 +28,7 @@ library(mirai)
 
 cl <- makeCluster(6, type = "MIRAI")
 cl
-#> < miraiCluster | ID: `1` nodes: 6 active: TRUE >
+#> < miraiCluster | ID: `0` nodes: 6 active: TRUE >
 parLapply(cl, iris, mean)
 #> $Sepal.Length
 #> [1] 5.843333
@@ -54,7 +54,7 @@ status(cl)
 #> [1] 6
 #> 
 #> $daemons
-#> [1] "abstract://1ffa515b477cb048623e8a7c"
+#> [1] "ipc:///tmp/8262e7fcb3b17b9f4a1260cf"
 stopCluster(cl)
 ```
 
@@ -65,10 +65,10 @@ cl <- make_cluster(n = 2, url = host_url())
 #> Shell commands for deployment on nodes:
 #> 
 #> [1]
-#> Rscript -e 'mirai::daemon("tcp://192.168.1.71:36061",dispatcher=FALSE,cleanup=FALSE,rs=c(10407,608223508,314351877,910111234,-668523109,970783776,-1964800607))'
+#> Rscript -e 'mirai::daemon("tcp://192.168.7.12:49778",dispatcher=FALSE,cleanup=FALSE,rs=c(10407,-1371709182,102090907,-1019444448,-314728287,-1138569746,977403287))'
 #> 
 #> [2]
-#> Rscript -e 'mirai::daemon("tcp://192.168.1.71:36061",dispatcher=FALSE,cleanup=FALSE,rs=c(10407,1589879997,1665986728,-2021887029,-1113401414,1948876325,1799837871))'
+#> Rscript -e 'mirai::daemon("tcp://192.168.7.12:49778",dispatcher=FALSE,cleanup=FALSE,rs=c(10407,-2003393061,101709059,-2143338667,404319410,-1028859762,-51192095))'
 stop_cluster(cl)
 ```
 
@@ -92,10 +92,10 @@ registerDoParallel(cl)
 m <- matrix(rnorm(9), 3, 3)
 foreach(i = 1:nrow(m), .combine = rbind) %dopar%
   (m[i, ] / mean(m[i, ]))
-#>                [,1]      [,2]      [,3]
-#> result.1  0.5373009  1.073723  1.388976
-#> result.2 -8.7848778  7.635917  4.148961
-#> result.3 -3.6102409 10.285887 -3.675646
+#>               [,1]       [,2]       [,3]
+#> result.1  3.213601 -0.2546854  0.0410841
+#> result.2 -1.581967  7.0901582 -2.5081915
+#> result.3  1.459975 -0.4330745  1.9730994
 
 # simple parallel matrix multiply
 a <- matrix(1:16, 4, 4)