dsl: tic's domain-specific language

In ropenscilabs/tic: Tasks Integrating Continuously: CI-Agnostic Workflow Definitions

tic's domain-specific language

Description

Functions to define stages and their constituent steps. The macros combine several steps and assign them to relevant stages. See dsl_get() for functions to access the storage for the stages and their steps.

get_stage() returns a TicStage object for a stage given by name. This function can be called directly in the tic.R configuration file, which is processed by dsl_load().

add_step() adds a step to a stage, see step_hello_world() and the links therein for available steps.

add_code_step() is a shortcut for add_step(step_run_code(...)).

Usage

get_stage(name)

add_step(stage, step)

add_code_step(stage, call = NULL, prepare_call = NULL)

Arguments

name	⁠[string]⁠ The name for the stage.
stage	⁠[TicStage]⁠ A TicStage object as returned by get_stage().
step	⁠[function]⁠ An object of class TicStep, usually created by functions with the step_ prefix like step_hello_world().
call	⁠[call]⁠ An arbitrary R expression executed during the stage to which this step is added. The default is useful if you only pass prepare_call.
prepare_call	⁠[call]⁠ An optional arbitrary R expression executed during preparation.

Examples

dsl_init()

get_stage("script")

get_stage("script") %>%
  add_step(step_hello_world())

get_stage("script")

get_stage("script") %>%
  add_code_step(print("Hi!"))

get_stage("script")

ropenscilabs/tic documentation built on Feb. 5, 2024, 5:06 p.m.