Fix docs

mrc-ide · Oct 3, 2024 · d737c55 · d737c55
1 parent 1bd6410
commit d737c55
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/R/rrq.R b/R/rrq.R
@@ -20,16 +20,20 @@
 ##' @param set_as_default Set the rrq controller to be the default;
 ##'   this is usually what you want.
 ##'
+##' @param queue_id The rrq queue id to use. You shouldn't need to pass a value
+##'   for this: the queue id can be found from the hipercow state directory, or
+##'   a new one is created if needed.
+##'
 ##' @inheritParams task_create_expr
 ##'
 ##' @return An [rrq::rrq_controller] object.
 ##'
 ##' @export
 hipercow_rrq_controller <- function(..., set_as_default = TRUE, driver = NULL,
-                                    queue_id = NA, root = NULL) {
+                                    queue_id = NULL, root = NULL) {
   root <- hipercow_root(root)
   call <- rlang::current_env()
-  if (is.na(queue_id)) {
+  if (is.null(queue_id)) {
     driver <- hipercow_driver_select(driver, TRUE, root, call)
     r <- rrq_prepare(driver, root, ..., call = call)
   } else {

diff --git a/man/hipercow_rrq_controller.Rd b/man/hipercow_rrq_controller.Rd