minor doc

Author: mschubert

README.md

@@ -10,14 +10,12 @@ This package will allow you to send function calls as jobs on a computing
 cluster with a minimal interface provided by the `Q` function:
 
 ```r
-# install the package if you haven't done so yet
+# install/load the package if you haven't done so yet
 install.packages('clustermq')
-
-# load the library and create a simple function
 library(clustermq)
-fx = function(x) x * 2
 
-# queue the function call on your scheduler
+# queue a function call on your scheduler
+fx = function(x) x * 2
 Q(fx, x=1:3, n_jobs=1)
 # list(2,4,6)
 ```
@@ -51,8 +49,7 @@ schedulers](https://mschubert.github.io/clustermq/articles/userguide.html#config
 * [SLURM](https://mschubert.github.io/clustermq/articles/userguide.html#slurm) - *should work without setup*
 * [LSF](https://mschubert.github.io/clustermq/articles/userguide.html#lsf) - *should work without setup*
 * [SGE](https://mschubert.github.io/clustermq/articles/userguide.html#sge) - *may require configuration*
-* [GCS](https://mschubert.github.io/clustermq/articles/userguide.html#gcs) - *needs* `options(clustermq.scheduler="GCS")`
-* [OCS](https://mschubert.github.io/clustermq/articles/userguide.html#ocs) - *needs* `options(clustermq.scheduler="OCS")` 
+* [GCS](https://mschubert.github.io/clustermq/articles/userguide.html#gcs)/[OCS](https://mschubert.github.io/clustermq/articles/userguide.html#ocs) - *needs* `options(clustermq.scheduler="GCS"/"OCS")`
 * [PBS](https://mschubert.github.io/clustermq/articles/userguide.html#pbs)/[Torque](https://mschubert.github.io/clustermq/articles/userguide.html#torque) - *needs* `options(clustermq.scheduler="PBS"/"Torque")`
 * via [SSH](https://mschubert.github.io/clustermq/articles/userguide.html#ssh-connector) -
 *needs* `options(clustermq.scheduler="ssh", clustermq.ssh.host=<yourhost>)`

vignettes/technicaldocs.Rmd

@@ -135,7 +135,6 @@ w$env(...)
 
 while (we have new work to send || jobs pending) {
     res = w$recv() # the result of the call, or NULL for a new worker
-    w$current()$call_ref # matches answer to request, -1 otherwise
     # handle result
 
     if (more work)

vignettes/userguide.Rmd

@@ -40,8 +40,7 @@ the bundled library:
 #   If your system has `libzmq` installed but you want to enable the worker
 #   crash monitor, set the environment variable below to use the bundled
 #   `libzmq` library with the required feature (`-DZMQ_BUILD_DRAFT_API=1`):
-
-# Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
+Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
 install.packages("clustermq")
 ```
 
@@ -50,8 +49,9 @@ Github. Note that this version needs `autoconf`/`automake` and `CMake` for
 compilation:
 
 ```{r eval=FALSE}
-# Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
-# install.packages('remotes')
+if (!requireNamespace("remotes", quietly=TRUE))
+    install.packages("remotes")
+Sys.setenv(CLUSTERMQ_USE_SYSTEM_LIBZMQ=0)
 remotes::install_github("mschubert/clustermq")
 # remotes::install_github("mschubert/clustermq@develop") # dev version
 ```
@@ -82,8 +82,7 @@ To set up a scheduler explicitly, see the following links:
 * [SLURM](#slurm) - *should work without setup*
 * [LSF](#lsf) - *should work without setup*
 * [SGE](#sge) - *may require configuration*
-* [GCS](#gcs) - *needs* `options(clustermq.scheduler="GCS")`
-* [OCS](#ocs) -  *needs* `options(clustermq.scheduler="OCS")`
+* [GCS](#gcs)/[OCS](#ocs) - *needs* `options(clustermq.scheduler="GCS"/"OCS")`
 * [PBS](#pbs)/[Torque](#torque) - *needs* `options(clustermq.scheduler="PBS"/"Torque")`
 * you can suggest another scheduler by [opening an
   issue](https://github.com/mschubert/clustermq/issues)
@@ -285,10 +284,10 @@ be available in your active session, while the latter will be available any
 time after you restart R.
 
 * `clustermq.scheduler` - One of the supported
-      [`clustermq` schedulers](#configuration); options are `"LOCAL"`,
-      `"multiprocess"`, `"multicore"`, `"lsf"`, `"sge"`, `"gcs"`, `"ocs"`, `"slurm"`, `"pbs"`,
-      `"Torque"`, or `"ssh"` (default is the HPC scheduler found in `$PATH`,
-      otherwise `"LOCAL"`)
+      [`clustermq` schedulers](#configuration); options are `"local"`,
+      `"multiprocess"`, `"multicore"`, `"lsf"`, `"sge"`, `"gcs"`, `"ocs"`,
+      `"slurm"`, `"pbs"`, `"torque"`, or `"ssh"` (default is the HPC scheduler
+      found in `$PATH`, otherwise `"local"`)
 * `clustermq.host` - The name of the node or device for constructing the
       `ZeroMQ` host address (default is `Sys.info()["nodename"]`)
 * `clustermq.ports` - A port range used by `clustermq` to initiate connections.