implement get_current_workflow_step

Author: AdrienLeGuillou

DESCRIPTION

@@ -29,6 +29,6 @@ Suggests:
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.1
 VignetteBuilder: knitr
 Language: en-US

NAMESPACE

@@ -3,6 +3,7 @@
 export(add_workflow_step)
 export(change_next_workflow_step)
 export(create_workflow)
+export(get_current_workflow_step)
 export(get_workflow_root)
 export(helper_use_setup_lines)
 export(helper_write_instructions)

R/workflow.R

@@ -158,6 +158,9 @@ get_workflow_root <- function(wf_summary = NULL) {
 #' \dontrun{
 #'  # Instruct the workflow to run the step 3 after this one
 #'  change_next_workflow_step(3)
+#'
+#'  # Instruct the workflow to run the previous step after this one
+#'  change_next_workflow_step(get_current_workflow_step() - 1)
 #' }
 #'
 #' @export
@@ -200,3 +203,12 @@ change_next_workflow_step <- function(next_step, sbatch_opts = NULL) {
   writeLines(as.character(next_step), next_step_file)
   invisible(next_step)
 }
+
+#' Get the number of the currently running step of a workflow
+#'
+#' @return The `current_step` value
+#'
+#' @export
+get_current_workflow_step <- function() {
+  Sys.getenv("SWF_CUR")
+}

inst/templates/step_tmpl_map.R

@@ -17,7 +17,7 @@ if (swf__array_id == swf__array_max) {
     sbatch_opts <- list("array" = paste0(next_slice_beg, "-", next_slice_end))
 
     slurmworkflow::change_next_workflow_step(
-      next_step = Sys.getenv("SWF_CUR"),
+      next_step = get_current_workflow_step(),
       sbatch_opts = sbatch_opts
     )