From 5a78d0fde5496b5080953ce3f7fd0dcd910a84fc Mon Sep 17 00:00:00 2001 From: shikokuchuo <53399081+shikokuchuo@users.noreply.github.com> Date: Thu, 26 Oct 2023 12:21:01 +0100 Subject: [PATCH] regenerate README and vignettes --- DESCRIPTION | 2 +- NEWS.md | 2 +- README.Rmd | 2 +- README.md | 10 ++--- vignettes/mirai.Rmd | 98 +++++++++++++++++++++--------------------- vignettes/precompile.R | 2 +- 6 files changed, 58 insertions(+), 58 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 8ce15ac8d..5dd080e27 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -23,7 +23,7 @@ Encoding: UTF-8 Depends: R (>= 3.5) Imports: - nanonext (>= 0.10.2.9011), + nanonext (>= 0.10.2.9012), parallel Enhances: promises diff --git a/NEWS.md b/NEWS.md index 60049d21b..984524716 100644 --- a/NEWS.md +++ b/NEWS.md @@ -12,7 +12,7 @@ * Fixes supplying an `ssh_config()` specifying tunnelling to the 'remote' argument of `daemons()`. * Fixes the print method for a subset 'miraiCluster' (thanks @HenrikBengtsson #83). * Removes the deprecated deferred evaluation pipe `%>>%`. -* Requires nanonext >= [0.10.2.9011]. +* Requires nanonext >= [0.10.2.9012]. # mirai 0.11.0 diff --git a/README.Rmd b/README.Rmd index 25283b0d4..a18e9fd99 100644 --- a/README.Rmd +++ b/README.Rmd @@ -17,7 +17,7 @@ knitr::opts_chunk$set( [![CRAN status](https://www.r-pkg.org/badges/version/mirai?color=112d4e)](https://CRAN.R-project.org/package=mirai) -[![mirai status badge](https://shikokuchuo.r-universe.dev/badges/mirai?color=24a60e)](https://shikokuchuo.r-universe.dev/) +[![mirai status badge](https://shikokuchuo.r-universe.dev/badges/mirai?color=24a60e)](https://shikokuchuo.r-universe.dev/builds) [![R-CMD-check](https://github.com/shikokuchuo/mirai/workflows/R-CMD-check/badge.svg)](https://github.com/shikokuchuo/mirai/actions) [![codecov](https://codecov.io/gh/shikokuchuo/mirai/branch/main/graph/badge.svg)](https://app.codecov.io/gh/shikokuchuo/mirai) [![DOI](https://zenodo.org/badge/459341940.svg)](https://zenodo.org/badge/latestdoi/459341940) diff --git a/README.md b/README.md index 81631164d..96673d251 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![CRAN status](https://www.r-pkg.org/badges/version/mirai?color=112d4e)](https://CRAN.R-project.org/package=mirai) [![mirai status -badge](https://shikokuchuo.r-universe.dev/badges/mirai?color=24a60e)](https://shikokuchuo.r-universe.dev/) +badge](https://shikokuchuo.r-universe.dev/badges/mirai?color=24a60e)](https://shikokuchuo.r-universe.dev/builds) [![R-CMD-check](https://github.com/shikokuchuo/mirai/workflows/R-CMD-check/badge.svg)](https://github.com/shikokuchuo/mirai/actions) [![codecov](https://codecov.io/gh/shikokuchuo/mirai/branch/main/graph/badge.svg)](https://app.codecov.io/gh/shikokuchuo/mirai) [![DOI](https://zenodo.org/badge/459341940.svg)](https://zenodo.org/badge/latestdoi/459341940) @@ -88,8 +88,8 @@ result. ``` r m$data -#> [1] -0.17710697 0.46078641 0.88270074 0.06083251 0.05059646 1.00000000 -#> [7] 19.76422946 16.43857757 1.13288678 2.17020290 -5.64630529 +#> [1] 2.2561892 1.1985734 1.4094865 0.8684176 0.8238311 1.0000000 1.2138410 +#> [8] 1.1515197 0.7094783 0.8343252 0.4432252 ``` Alternatively, explicitly call and wait for the result using @@ -97,8 +97,8 @@ Alternatively, explicitly call and wait for the result using ``` r call_mirai(m)$data -#> [1] -0.17710697 0.46078641 0.88270074 0.06083251 0.05059646 1.00000000 -#> [7] 19.76422946 16.43857757 1.13288678 2.17020290 -5.64630529 +#> [1] 2.2561892 1.1985734 1.4094865 0.8684176 0.8238311 1.0000000 1.2138410 +#> [8] 1.1515197 0.7094783 0.8343252 0.4432252 ``` ### Vignette diff --git a/vignettes/mirai.Rmd b/vignettes/mirai.Rmd index f65a4e8b0..d238c92ca 100644 --- a/vignettes/mirai.Rmd +++ b/vignettes/mirai.Rmd @@ -69,7 +69,7 @@ Upon completion, the 'mirai' resolves automatically to the evaluated result. ```r m$data |> str() -#> num [1:100000000] -0.881 -0.16 0.678 0.459 -0.269 ... +#> num [1:100000000] 57.804 -1.941 -7.661 0.387 0.777 ... ``` Alternatively, explicitly call and wait for the result using `call_mirai()`. @@ -77,7 +77,7 @@ Alternatively, explicitly call and wait for the result using `call_mirai()`. ```r call_mirai(m)$data |> str() -#> num [1:100000000] -0.881 -0.16 0.678 0.459 -0.269 ... +#> num [1:100000000] 57.804 -1.941 -7.661 0.387 0.777 ... ``` For easy programmatic use of `mirai()`, '.expr' accepts a pre-constructed language object, and also a list of named arguments passed via '.args'. So, the following would be equivalent to the above: @@ -94,7 +94,7 @@ args <- list(m = runif(1), n = 1e8) m <- mirai(.expr = expr, .args = args) call_mirai(m)$data |> str() -#> num [1:100000000] 0.589 -1.306 0.967 -3.723 1.293 ... +#> num [1:100000000] 0.123 0.733 0.649 1.472 5.71 ... ``` [« Back to ToC](#table-of-contents) @@ -180,8 +180,8 @@ for (i in 1:10) { #> iteration 4 successful #> iteration 5 successful #> iteration 6 successful -#> Error: random error #> iteration 7 successful +#> Error: random error #> iteration 8 successful #> iteration 9 successful #> iteration 10 successful @@ -221,12 +221,12 @@ status() #> #> $daemons #> i online instance assigned complete -#> abstract://ea4e4f73480ee03abf774685 1 1 1 0 0 -#> abstract://82b472f5c4028c57e541f60d 2 1 1 0 0 -#> abstract://519f74caf98fca0b1d949c2c 3 1 1 0 0 -#> abstract://33f8257f9d4b687ff5784d2e 4 1 1 0 0 -#> abstract://69463b3c8e108d9eb39c88f1 5 1 1 0 0 -#> abstract://f5e5e9a3ca6b7c86faa3ea78 6 1 1 0 0 +#> abstract://2c91f63f732bdd18c473ec80 1 1 1 0 0 +#> abstract://3b690e927a6d8d9be7b8eb64 2 1 1 0 0 +#> abstract://2c4aa81c2d6e20d10998049f 3 1 1 0 0 +#> abstract://4521e936800ac3da2a5cce9e 4 1 1 0 0 +#> abstract://96c4b425a2eda1175e24a33d 5 1 1 0 0 +#> abstract://12f6dc8cdb6aa4fabed7300e 6 1 1 0 0 ``` The default `dispatcher = TRUE` creates a `dispatcher()` background process that connects to individual daemon processes on the local machine. This ensures that tasks are dispatched efficiently on a first-in first-out (FIFO) basis to daemons for processing. Tasks are queued at the dispatcher and sent to a daemon as soon as it can accept the task for immediate execution. @@ -261,7 +261,7 @@ status() #> [1] 6 #> #> $daemons -#> [1] "abstract://403671466c70abcf0b9cc5ed" +#> [1] "abstract://d5a7ab71b50c27f6e81196d0" ``` This implementation sends tasks immediately, and ensures that tasks are evenly-distributed amongst daemons. This means that optimal scheduling is not guaranteed as the duration of tasks cannot be known *a priori*. As an example, tasks could be queued at a daemon behind a long-running task, whilst other daemons are idle having already completed their tasks. @@ -352,7 +352,7 @@ By specifying `dispatcher = FALSE`, remote daemons connect directly to the host ```r daemons(url = host_url(), dispatcher = FALSE) -#> [1] "tcp://hostname:42425" +#> [1] "tcp://hostname:35033" ``` Note that above, calling `host_url()` without a port value uses the default of '0'. This is a wildcard value that will automatically cause a free ephemeral port to be assigned. The actual assigned port is provided in the return value of the call, or it may be queried at any time via `status()`. @@ -368,7 +368,7 @@ status() #> [1] 0 #> #> $daemons -#> [1] "tcp://hostname:42425" +#> [1] "tcp://hostname:35033" ``` To reset all connections and revert to default behaviour: @@ -445,10 +445,10 @@ daemons(n = 2, url = host_url()) launch_remote(1:2) #> [1] -#> Rscript -e "mirai::daemon('tcp://hostname:34249',rs=c(10407,-1105765197,-987934120,-1476302727,65523174,-1275424977,1746471844))" +#> Rscript -e "mirai::daemon('tcp://hostname:40815',rs=c(10407,-1298605964,-1613285147,639709282,1751824507,-1051788928,-932623487))" #> #> [2] -#> Rscript -e "mirai::daemon('tcp://hostname:37533',rs=c(10407,1082223346,-259998318,-1749716360,1849777031,1147350196,-1875717415))" +#> Rscript -e "mirai::daemon('tcp://hostname:39985',rs=c(10407,1124331931,1808224896,-1742832536,-639982197,-1545947632,1369966981))" daemons(0) #> [1] 0 @@ -480,37 +480,37 @@ The generated self-signed certificate is available via `launch_remote()`. This f ```r launch_remote(1) #> [1] -#> Rscript -e "mirai::daemon('wss://hostname:36005/1',tls=c('-----BEGIN CERTIFICATE----- +#> Rscript -e "mirai::daemon('wss://hostname:44085/1',tls=c('-----BEGIN CERTIFICATE----- #> MIIFNzCCAx+gAwIBAgIBATANBgkqhkiG9w0BAQsFADAzMREwDwYDVQQDDAhrdW1h #> bW90bzERMA8GA1UECgwITmFub25leHQxCzAJBgNVBAYTAkpQMB4XDTAxMDEwMTAw #> MDAwMFoXDTMwMTIzMTIzNTk1OVowMzERMA8GA1UEAwwIa3VtYW1vdG8xETAPBgNV #> BAoMCE5hbm9uZXh0MQswCQYDVQQGEwJKUDCCAiIwDQYJKoZIhvcNAQEBBQADggIP -#> ADCCAgoCggIBAL/MGIpcKJcWhX5raqLDYSbuF2PaO7rOf7XfGr3heJd3LAfwUydO -#> +w9xJR390wBPRMVbxicF2VkV4+HuEufSw/GHVibguO+dXeDG1vESaL6+0NY24gJi -#> KfSDqFMHMeGpIuZgmN/FAzgR/rln4hh/jHnBP6ybIhZE8utkjeYrZygBuUELLew6 -#> qyFywnF+VMyawddMd2IwNj6vJSi9hHLuexCI4fxpemxTLJJBAIh2zJrMc7W/726n -#> brKa1FSU0Z/JGz8dfsS6TXTN0pYSvguesByDAR7RwZEhvTbEeGQeZeRo6VJXsbSY -#> 16lXypgDHFr5Tg+5rxAE9y14/3AxuWT3WUkfsdN2eIKj619IokNxx53eHP6ETNPY -#> lAWHkOgMNsee15+LkjkaLUr607vsSLT/F0yPUfzqXIxqfQGZjHoWv8N3E3Kuj/k7 -#> I2BOApmJw6ML77IOzIepgCJALQCk1x+vfWURmaK2TiMgrEGp2tZW4D5Rd5EuLl9Z -#> yPMnlkPXuHBKNSNt89Mr5hhVgdOmNkWqs1t2x3ZkkK3tEFqaOL066EsDs+MTEfZU -#> bHK57vP6vrNJTFDTx5vRPy44OEJrpBdvxMVmGx7GoUNoTNonuHZ2/qz/ApObrQtm -#> 1OO4ThrHuq6tC/M9isM+++e+WkajjstROz2pfjdetQ7qkKaikWfUStiHAgMBAAGj -#> VjBUMBIGA1UdEwEB/wQIMAYBAf8CAQAwHQYDVR0OBBYEFLGysTDmP/CxolcONFpG -#> fbheVPvFMB8GA1UdIwQYMBaAFLGysTDmP/CxolcONFpGfbheVPvFMA0GCSqGSIb3 -#> DQEBCwUAA4ICAQBXS2wNTnA43iQLOIkXWi84wSWhO7WwLApbgpcCaLeC/NyS35ZE -#> fPMYKKaFeQkmSK42k/LM51v7qaisregKJ9/LAydm5EiHt09twCrueUV/2ZPCTuii -#> RMiiMA0zURjP6iLUN3wPHKaYVawue7eqzY3pW1mNffykyizT9SGClsTI0wp541bT -#> hOc/+Igqec4zLPcAl2kuJBfQ0CoXaD5odW7bDUipHuN8IjlM1Xew0Nvdd9TvKbvL -#> NEp6Y5EBfYe0svoVgR0HYkSh2p0wgyop5bTNzTzqmGNtx8mzjbgYwgHPbWVV9E2b -#> tVZyRZwpLXJQhR8NhWMnh3nP7/TbXDU982VXfdOIf4UiBjkU2hP8BZo473gHxl6T -#> wgsTkUWYZY8FoH3GoiGbAdzMC8psa9TKpMlaOw6Y4VF93NXYWwzkiGHBb/vdzQ07 -#> 6YRN5L9s/a6QVswPt15Cgcj9FwiMIL1p2Par6rIwRT384RLe6hlNEsjAOFM/7aeM -#> n7ltnjBE5cNW99BdIt/I15NPZ0CoFZjmJm1w3xkoyRn76XjlA00DoZ0bNq/Ap/o7 -#> a1mGhj8QzpzGzzvC7A9BIJXEypN7l9yQ3DLmqsDkD0o8r8simwrjYXxBPxbG3WwD -#> pJB7uUWSkJEqmVZI6vOdGPovRKSVCWN19UgW3926HsQlhOLdRh5xUT2JAQ== +#> ADCCAgoCggIBAJfcvcHmr4Io9XXaE/2T7QAEBoxtdPZxF30hgu5wjNJA5d2SrKzY +#> SQRTmwTT4yTjFIn6D7Z12g1blK7cPZ7IQbD53z76jJe0ySMQA/7q4koYtLxhIUfm +#> ISoBkxZs1uN91cM0epVEcr+NBiqYBbwXS1KfBPPyxJA4/pBnyOA+X/bFXJEj6ldX +#> 6ahWNHuMPrXdrI8T1YZX7ox+kW/PqwHdVdbrniAC7Z/IFOrjA8h7fxVuHnFcZ0Nv +#> yYV2fWTiBIZg9YnRsmCDt7uUPQg+P2JcpgNRJd4Y5dlQRjL1hF1gNld5lkRwiIE0 +#> 1n9Sm7ep+BUKRqNJPriT8hRcXSD0p+vsUmr0i81uUJNWEr1iOZDKkr03pZgsuaA7 +#> 9d+tEaq8mgrwsrYBw3+VPFu1gzPumZztkmPTw6DQfHGA5ivcmj7q7fEWgAsLOZxi +#> 0IZ3PKBdbvrvV1XZtP7wdH4d8E/+ZDHAy0VnugAjEPRIgsV0liCK6KLpUWyOn/WG +#> 6oBMpWg2mqhtomN6vO/k0l8muHuFgHOyVIoerrc6OeTPbfUWVXASj4BnMJ+9xN9+ +#> wVNUwEYp58X1NQxvVmuaGx9gsxoCmeR48AoLE1ehee6vlIsebX5Ec+Z8ntA7a+ks +#> T6YxZUvigddaTinNZ/ZXuPTy84cb9ixK6q7KkWz1htauADW7auQHPIDJAgMBAAGj +#> VjBUMBIGA1UdEwEB/wQIMAYBAf8CAQAwHQYDVR0OBBYEFJT2qxTuAnDrnwTdzs40 +#> 4fGJBdHQMB8GA1UdIwQYMBaAFJT2qxTuAnDrnwTdzs404fGJBdHQMA0GCSqGSIb3 +#> DQEBCwUAA4ICAQA3IFY7QadfMJS8NxUYTQD7FJa2eOICE9pog+gxRXFXkcV+xXVJ +#> oJ7EnG87vwvH96GOvrV5Q9882zA6tecXgIYCFYKGlOXTVw0OYE80yxIZvEuMgFdi +#> oDIc6xgfJ8xvKfx2c9ePEhRQQqm2c9jxeFsvzqSBtKq/LEBFvD3ZgFv3I7mQjaO9 +#> MmfCzOkNshq7F9G3U39k+k4+Q4f+nk6smtZQbDWrBnAUxUd2jvgO0fk0WR6DjwSI +#> Ji+gjOqGYFc85mPcFGmtAFbaAe/FfhPyLHvVSMMfqjIDDR5oyYkXTk8eCd2rYbsE +#> I5AmAsr86R9HOA5fjmA0/iV0AZPiLZlAzVqsPaTbVtd7hwvLsro2IyYvrdPwNTHO +#> FOaCnIk6xaQaud0ICY3/RmBRVCYi7tbuZfSf5khPvRrC/6FMrQFT442Pq9ZMRaF2 +#> 7b7lbdjfX+JCnR5xKbVS4aw/pJrtG/D2z+I5qMeCLJ4MqJNECE6kxC/w1Iq3N4iN +#> Cd+gbstgHEAihS+ySife7uv4gbWu++xOESNJ4RRNZmksjhddRkQfy+nCMsFBbisC +#> T5JL43Jx2ASZXEaOPX7Q3URXO5xgTRTkFP/or10s4g2BaUya71AQheD6Z5uc/6kp +#> EaPys8D8HzD27GQ/ASLDeNlf5bTJaDhx/uzb8Q9KX2GA0x6gwKfGb+iX1w== #> -----END CERTIFICATE----- -#> ',''),rs=c(10407,-612861450,1470179327,-2095842764,-186122331,-446162910,364318011))" +#> ',''),rs=c(10407,1009925696,-5957311,851346958,-714207433,-1893795316,680318877))" ``` The printed value may be deployed directly on a remote machine. @@ -634,36 +634,36 @@ cl parallel::parLapply(cl, 1:5, rnorm) #> [[1]] -#> [1] -1.050956 +#> [1] -0.9836203 #> #> [[2]] -#> [1] 0.09537212 1.21054851 +#> [1] 1.0656311 0.5503744 #> #> [[3]] -#> [1] 0.7275608 0.4683658 -0.2090602 +#> [1] 0.2525613 -0.8804021 0.5376508 #> #> [[4]] -#> [1] -0.2758327 0.5478251 0.8320594 0.5868575 +#> [1] -1.968415e-05 1.351948e+00 1.176134e+00 1.551765e+00 #> #> [[5]] -#> [1] 1.37343219 1.65095515 0.60969256 0.84537855 -0.05773324 +#> [1] -0.5270231 0.4128853 -0.1984081 0.8376930 -1.1472594 status(cl) #> $connections #> [1] 4 #> #> $daemons -#> [1] "abstract://27d66a0c42c6b30cadeb5489" +#> [1] "abstract://757f162f5903b2ccf58e3782" stop_cluster(cl) cl <- make_cluster(n = 2, url = host_url()) #> Shell commands for deployment on nodes: #> [1] -#> Rscript -e "mirai::daemon('tcp://hostname:42027',rs=c(10407,-30659088,-173672143,482412862,-582316889,-1971446596,1798213261))" +#> Rscript -e "mirai::daemon('tcp://hostname:39797',rs=c(10407,-1845852469,625033104,1695168081,-1539269666,1803884231,-226338724))" #> #> [2] -#> Rscript -e "mirai::daemon('tcp://hostname:42027',rs=c(10407,1389902600,123182236,2739438,206106783,-1575032522,-1704684541))" +#> Rscript -e "mirai::daemon('tcp://hostname:39797',rs=c(10407,-951338746,-573234744,-1153439598,1348855247,1553839924,-21456304))" stop_cluster(cl) ``` diff --git a/vignettes/precompile.R b/vignettes/precompile.R index 4c7f68053..add8b0524 100644 --- a/vignettes/precompile.R +++ b/vignettes/precompile.R @@ -1,2 +1,2 @@ -# Vignettes precompiled as require connecting to remote resources interactively +# Vignettes precompiled as require connecting to remote resources knitr::knit("vignettes/mirai.Rmd.orig", "vignettes/mirai.Rmd")