@@ -35,7 +35,7 @@ Install the `clustermq` package in R from CRAN. This will automatically detect
3535if [ ZeroMQ] ( https://github.com/zeromq/libzmq ) is installed and otherwise use
3636the bundled library:
3737
38- ``` r
38+ ``` {r eval=FALSE}
3939# Recommended:
4040# If your system has `libzmq` installed but you want to enable the worker crash
4141# monitor, set the following environment variable to enable compilation of the
@@ -47,7 +47,8 @@ install.packages('clustermq')
4747Alternatively you can use the ` remotes ` package to install directly from
4848Github. Note that this version needs ` autoconf ` /` automake ` for compilation:
4949
50- ``` r
50+ ``` {r eval=FALSE}
51+ # Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
5152# install.packages('remotes')
5253remotes::install_github('mschubert/clustermq')
5354```
@@ -59,6 +60,7 @@ However, [feedback is very
5960welcome] ( https://github.com/mschubert/clustermq/issues/new ) .
6061
6162``` {r eval=FALSE}
63+ # Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
6264# install.packages('remotes')
6365remotes::install_github('mschubert/clustermq', ref="develop")
6466```
@@ -69,6 +71,7 @@ Choose your preferred parallelism using:
6971
7072``` {r eval=FALSE}
7173options(clustermq.scheduler = "your scheduler here")
74+ # this may require additional setup, for details see below
7275```
7376
7477There are three kinds of schedulers:
@@ -106,7 +109,7 @@ To set up a scheduler explicitly, see the following links:
106109* [ SGE] ( #SGE ) - * should work without setup*
107110* [ SLURM] ( #SLURM ) - * should work without setup*
108111* [ PBS] ( #PBS ) /[ Torque] ( #TORQUE ) - * needs* ` options(clustermq.scheduler="PBS"/"Torque") `
109- * if you want another scheduler, [ open an
112+ * you can suggest another scheduler by [ opening an
110113 issue] ( https://github.com/mschubert/clustermq/issues/new )
111114
112115Default submission templates [ are
@@ -212,7 +215,7 @@ Q(fx, x=1:3, export=list(y=10), n_jobs=1)
212215```
213216
214217If we want to use a package function we need to load it on the worker using the
215- ` pkg ` argument or referencing it with ` package_name:: ` :
218+ ` pkg ` argument or referencing it with ` package_name:: ` .
216219
217220``` {r}
218221fx = function(x) {
@@ -259,29 +262,22 @@ register(DoparParam()) # after register_dopar_cmq(...)
259262bplapply(1:3, sqrt)
260263```
261264
262- ### With ` drake `
265+ ### With ` targets `
263266
264- The [ ` drake ` ] ( https://github.com/ropensci/drake ) package enables users to
267+ The [ ` targets ` ] ( https://github.com/ropensci/targets ) package enables users to
265268define a dependency structure of different function calls, and only evaluate
266269them if the underlying data changed.
267270
268- > drake — or, Data Frames in R for Make — is a general-purpose workflow manager
269- > for data-driven tasks. It rebuilds intermediate data objects when their
270- > dependencies change, and it skips work when the results are already up to
271- > date. Not every runthrough starts from scratch , and completed workflows have
272- > tangible evidence of reproducibility. drake also supports scalability,
273- > parallel computing, and a smooth user experience when it comes to setting up,
274- > deploying, and maintaining data science projects .
271+ > The ` targets ` package is a [ Make ] ( https://www.gnu.org/software/make/ ) -like
272+ > pipeline tool for statistics and data science in R. The package skips costly
273+ > runtime for tasks that are already up to date, orchestrates the necessary
274+ > computation with implicit parallel computing , and abstracts files as R
275+ > objects. If all the current output matches the current upstream code and
276+ > data, then the whole pipeline is up to date, and the results are more
277+ > trustworthy than otherwise .
275278
276- It can use ` clustermq ` to perform calculations as jobs:
277-
278- ``` {r eval=FALSE}
279- library(drake)
280- load_mtcars_example()
281- # clean(destroy = TRUE)
282- # options(clustermq.scheduler = "multicore")
283- make(my_plan, parallelism = "clustermq", jobs = 2, verbose = 4)
284- ```
279+ It can use ` clustermq ` to [ perform calculations as
280+ jobs] ( https://books.ropensci.org/targets/hpc.html#clustermq ) .
285281
286282## Options
287283
0 commit comments