added Slurm sbatch example in remote_config() docs (thanks @michaelma…

…yer2)
shikokuchuo · Oct 30, 2024 · 67a19fb · 67a19fb
1 parent 622c788
commit 67a19fb
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git a/R/launchers.R b/R/launchers.R
@@ -198,14 +198,22 @@ launch_remote <- function(url, remote = remote_config(), ..., tls = NULL, .compu
 #'   \code{\link{make_cluster}}.
 #'
 #' @examples
-#' # example for Slurm
+#' # Slurm srun example
 #' remote_config(
 #'   command = "srun",
 #'   args = c("--mem 512", "-n 1", "."),
 #'   rscript = file.path(R.home("bin"), "Rscript")
 #' )
 #'
-#' # commands like SSH require quoting of the daemon launch command
+#' # Slurm sbatch requires 'quote = TRUE'
+#' remote_config(
+#'   command = "sbatch",
+#'   args = c("--mem 512", "-n 1", "--wrap", "."),
+#'   rscript = file.path(R.home("bin"), "Rscript"),
+#'   quote = TRUE
+#' )
+#'
+#' # SSH also requires 'quote = TRUE'
 #' remote_config(
 #'   command = "/usr/bin/ssh",
 #'   args = c("-fTp 22 10.75.32.90", "."),

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