step_tmpl_do_call: Step template to run an R function

In AdrienLeGuillou/slurmworkflow: Build workflows for the Slurm workload manager

Description

This step template uses a syntax similar to the base::do.call function to run a function as a workflow step. You must make sure that all variables required by the function are passed to it either as one of its arguments or loaded later by the function itself.

Usage

step_tmpl_do_call(what, args, setup_script = NULL)

Arguments

what	The R function to be run by the workflow step
args	a list of arguments to the function call. The names attribute of args gives the argument names.
setup_script	(optional) a bash script to be run first. This can be used to load the required modules (like R, python, etc).

Value

a template function to be used by add_workflow_step

Step Template

Step Templates are helper functions to be used within add_workflow_step. Some basic ones are provided by the slurmworkflow package. They instruct the workflow to run either a bash script, a set of bash lines given as a character vector or an R script. Additional Step Templates can be created to simplify specific tasks, see the vignette("making-a-custom-step-template") for details.

AdrienLeGuillou/slurmworkflow documentation built on Jan. 13, 2022, 5:13 p.m.