submit_flow: Submit a flow to the cluster

In sahilseth/flowr: Streamlining Design and Deployment of Complex Workflows

Description

Submit a flow to the cluster or perform a dry-run to check and debug issues.

Usage

submit_flow(x, verbose = opts_flow$get("verbose"), ...)

## S3 method for class 'list'
submit_flow(x, verbose = opts_flow$get("verbose"), ...)

## S3 method for class 'flow'
submit_flow(
  x,
  verbose = opts_flow$get("verbose"),
  execute = FALSE,
  uuid,
  plot = TRUE,
  dump = TRUE,
  .start_jid = 1,
  ...
)

Arguments

x	a object of class flow.
verbose	logical.
...	Advanced use. Any additional parameters are passed on to submit_job function.
execute	logical whether or not to submit the jobs
uuid	character Advanced use. This is the final path used for flow execution. Especially useful in case of re-running a flow.
plot	logical whether to make a pdf flow plot (saves it in the flow working directory).
dump	dump all the flow details to the flow path
.start_jid	Job to start this submission from. Advanced use, should be 1 by default.

Details

NOTE: Even if you want to kill the flow, its best to let submit_flow do its job, when done simply use kill(flow_wd). If submit_flow is interrupted, files like flow_details.rds etc are not created, thus flowr looses the association of jobs with flow instance and cannot monitor, kill or re-run the flow.

Examples

## Not run: 
submit_flow(fobj = fobj, ... = ...)
## End(Not run)

sahilseth/flowr documentation built on March 20, 2021, 8:44 a.m.