Function reference • slurmworkflow

Workflow Creation

Functions to create and edit a workflow

create_workflow(): Create a New Workflow

add_workflow_step(): Add a Step to an Existing Workflow

Step Templates

Functions governing what is run by a step.

step_tmpl_bash_lines(): Step Template to Run Bash Statements

step_tmpl_bash_script(): Step Template to Run a Bash Script

step_tmpl_do_call(): Step Template to Run an R Function

step_tmpl_do_call_script(): Step Template to Run an R Script With a Set of Arguments

step_tmpl_map(): Step Template to Run an R Function With a Set of Arguments

step_tmpl_map_script(): Step Template to Run an R Script With a Set of Arguments

step_tmpl_rscript(): Step Template to Run an R Script

Changing the Execution Order

Functions to query the currently running step and change the step to be run next. These functions are to be used inside a workflow running on an HPC. They allow conditional execution and loop like behavior.

change_next_workflow_step(): Alter the Next Step of a Running Workflow

get_current_workflow_step(): Get the Number of the Currently Running Step of a Workflow

Utilities for Making Custom Step Templates

Functions used to create custom step templates from scratch. In most case, a new step template can be created as a wrapper around one of the existing templates.

get_workflow_root(): Get the Root Directory of a Workflow

load_workflow(): Load a Workflow Summary From a Workflow Folder or the Environment

helper_use_setup_lines(): Helper Function to Consistently Write Setup Lines

helper_write_instructions(): Helper Function to Consistently Write Instructions to the Instruction Script