update rscript tmpl doc

EpiModel · Apr 5, 2023 · 77639b5 · 77639b5
1 parent 8431c81
commit 77639b5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/R/step_templates.R b/R/step_templates.R
@@ -55,6 +55,10 @@ step_tmpl_bash_script <- function(bash_script) {
 
 #' Step Template to Run an R Script
 #'
+#' Contrary to `step_tmpl_do_call_script`, this function copies the content of
+#' the script to the workflow folder. Therefore, the script do not have to exist
+#' on the HPC when using this template.
+#'
 #' @param r_script The R script to be run by the workflow step
 #' @param setup_lines (optional) a vector of bash lines to be run first.
 #'   This can be used to load the required modules (like R, python, etc).

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