adds vignettes, inheritdotparams

.gitignore

@@ -3,3 +3,4 @@
 .RData
 .Ruserdata
 docs
+inst/doc

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: mirai
 Type: Package
 Title: Minimalist Async Evaluation Framework for R
-Version: 0.10.0.9018
+Version: 0.10.0.9019
 Description: Lightweight parallel code execution and distributed computing.
     Designed for simplicity, a 'mirai' evaluates an R expression asynchronously,
     on local or network resources, resolving automatically upon completion.
@@ -25,4 +25,8 @@ Depends:
 Imports: 
     nanonext (>= 0.10.1),
     parallel
+Suggests:
+    knitr,
+    rmarkdown
+VignetteBuilder: knitr
 RoxygenNote: 7.2.3

NEWS.md

@@ -1,4 +1,4 @@
-# mirai 0.10.0.9018 (development)
+# mirai 0.10.0.9019 (development)
 
 * Implements an alternative communications backend for R, adding methods for the 'parallel' base package.
   + Fulfils a request by R Core at R Project Sprint 2023, and requires R >= 4.4 (currently R-devel).
@@ -16,6 +16,8 @@
 * Reverts the trailing line break added to the end of a 'miraiError' character string.
 * Deprecates the Deferred Evaluation Pipe `%>>%` in favour of a recommendation to use package `mirai.promises` for performing side effects upon 'mirai' resolution.
 * Deprecated use of alias `server()` for `daemon()` is retired.
+* Document dot parameters for `daemons()` and `dispatcher()` (thanks @krlmlr #79).
+* Adds a 'reference' vignette, moving most of the information from the readme.
 * Requires nanonext >= 0.10.1.
 
 # mirai 0.10.0

R/daemons.R

@@ -27,6 +27,8 @@
 #'     else the low-level approach of distributing tasks to daemons equally.
 #'
 #' @inheritParams dispatcher
+#' @inheritDotParams dispatcher token:lock
+#' @inheritDotParams daemon maxtasks:cleanup
 #' @param n integer number of daemons to set.
 #' @param url [default NULL] if specified, the character URL or vector of URLs
 #'     on the host for remote daemons to dial into, including a port accepting

R/dispatcher.R

@@ -22,6 +22,7 @@
 #'     processing, using a FIFO scheduling rule, queuing tasks as required.
 #'
 #' @inheritParams daemon
+#' @inheritDotParams daemon maxtasks idletime walltime timerstart cleanup
 #' @param host the character host URL to dial (where tasks are sent from),
 #'     including the port to connect to (and optionally for websockets, a path),
 #'     e.g. 'tcp://192.168.0.2:5555' or 'ws://192.168.0.2:5555/path'.
@@ -50,8 +51,6 @@
 #' @param pass [default NULL] (required only if the private key supplied to 'tls'
 #'     is encrypted with a password) For security, should be provided through a
 #'     function that returns this value, rather than directly.
-#' @param ... additional arguments passed through to \code{\link{daemon}} if
-#'     launching local daemons i.e. 'url' is not specified.
 #' @param monitor (for package internal use only) do not set this parameter.
 #'
 #' @return Invisible NULL.