Define a targets pipeline as a tarflowr work unit.

This is a work unit constructor designed for hierarchical workflows. It creates a configuration object that describes a sub-project to be run as a single step within a larger tarflowr meta-pipeline.

Usage

tarflowr_project(project_dir, result_target, name = NULL)

Arguments

project_dir

The path to the directory containing the sub-project's _targets.R file.

result_target

The unquoted name of the target within the sub-project that should be returned as the result of this work unit.

name

(Optional) A short, descriptive name for this work unit, which will be used for naming branches in the main tarflowr pipeline. If NULL, the basename of the project_dir will be used.

Value

A structured list object (tarflowr_work_unit) containing the configuration for the sub-project.

Details

The object created by this function is intended to be passed as an element in the work_units list to tarflowr_run(), with tarflowr_run_subproject() set as the process_func.

Author

Andrew G. Brown