tic (version 0.2.13.9017)

dsl_get: Storage for stages and steps

Description

Stages and steps defined using tic's DSL are stored in an internal object in the package. The stages are accessible through dsl_get(). When running the stages, by default a configuration defined in the tic.R file is loaded with dsl_load(). See use_tic() for setting up a tic.R file.

For interactive tests, an empty storage can be initialized with dsl_init(). This happens automatically the first time dsl_get() is called (directly or indirectly).

Usage

dsl_get()
dsl_load(path = "tic.R", force = FALSE, quiet = FALSE)
dsl_init(quiet = FALSE)

Arguments

path

[string] Path to the stage definition file, default: "tic.R".

force

[flag] Set to TRUE to force loading from file even if a configuration exists. By default an existing configuration is not overwritten by dsl_load().

quiet

[flag] Set to TRUE to turn off verbose output.

Value

A named list of opaque stage objects with a "class" attribute and a corresponding print() method for pretty output. Use the high-level get_stage() and add_step() functions to configure, and the stages functions to run.

Examples

# NOT RUN {
dsl_init()
dsl_get()

dsl_load(system.file("templates/package/tic.R", package = "tic"))
dsl_load(system.file("templates/package/tic.R", package = "tic"), force = TRUE)
dsl_get()
# }