tar_blueprint: Add a blueprint to a "targets" pipeline

In nyuglobalties/blueprintr: Automagically Document and Test Datasets Using Targets Or Drake

Add a blueprint to a "targets" pipeline

Description

Unlike drake, which requires some extra metaprogramming to "attach" blueprint steps to a plan, targets pipelines allow for direct target construction. Blueprints can thus be added directly into a tar_pipeline() object using this function. The arguments for tar_blueprint() are exactly the same as blueprint(). tar_blueprints() behaves like load_blueprints() but is called, like tar_blueprint(), directly in a tar_pipeline() object.

Usage

tar_blueprint(...)

tar_blueprints(directory = here::here("blueprints"), recurse = FALSE)

tar_blueprint_raw(bp)

Arguments

...	Arguments passed to blueprint()
directory	A folder containing R scripts that evaluate to blueprint() objects
recurse	Recursively loads blueprints from a directory if TRUE
bp	A blueprint object

Value

A list() of tar_target objects

Empty blueprint folder

By default, blueprintr ignore empty blueprint folders. However, it may be beneficial to warn users if folder is empty, particularly during project setup. This helps identify any potential misconfiguration of targets generation. To enable these warnings, set option(blueprintr.warn_empty_blueprints_dirs = TRUE).

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