From 77639b52cf13de630c2e6125669d978d8b83900e Mon Sep 17 00:00:00 2001
From: Adrien Le Guillou <git@aleguillou.org>
Date: Wed, 5 Apr 2023 12:05:32 +0200
Subject: [PATCH] update rscript tmpl doc

---
 R/step_templates.R       | 4 ++++
 man/step_tmpl_rscript.Rd | 4 +++-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/R/step_templates.R b/R/step_templates.R
index a183496..29f2341 100644
--- 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
index c627b19..faf8e42 100644
--- a/man/step_tmpl_rscript.Rd
+++ b/man/step_tmpl_rscript.Rd
@@ -16,7 +16,9 @@ This can be used to load the required modules (like R, python, etc).}
 a template function to be used by \code{add_workflow_step}
 }
 \description{
-Step Template to Run an R Script
+Contrary to \code{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.
 }
 \section{Step Template}{