bpstep_payload: Create a step payload

View source: R/bpstep.R

bpstep_payloadR Documentation

Create a step payload

Description

The bpstep payload is the object that contains the target name and command, along with any other metadata to be passed to the execution engine.

Usage

bpstep_payload(target_name, target_command, ...)

Arguments

target_name

The target's name

target_command

The target's command

...

Arguments to be passed to the executing engine (e.g. arguments sent to targets::tar_target())

Value

A bpstep payload object

Examples

if (FALSE) {
  bpstep(
    step = "some_step",
    bp = some_bp_object,
    payload = bpstep_payload(
      "payload_name",
      payload_command()
    )
  )
}

nyuglobalties/blueprintr documentation built on July 16, 2024, 10:27 a.m.