use_targets: Use targets

In targets: Dynamic Function-Oriented 'Make'-Like Declarative Pipelines

Use targets

Description

Set up targets for an existing project.

Usage

use_targets(
  script = targets::tar_config_get("script"),
  open = interactive(),
  overwrite = FALSE,
  scheduler = NULL,
  job_name = NULL
)

Arguments

script	Character of length 1, where to write the target script file. Defaults to tar_config_get("script"), which in turn defaults to ⁠_targets.R⁠.
open	Logical of length 1, whether to open the file for editing in the RStudio IDE.
overwrite	Logical of length 1, TRUE to overwrite the the target script file, FALSE otherwise.
scheduler	Deprecated in version 1.5.0.9001 (2024-02-12).
job_name	Deprecated in version 1.5.0.9001 (2024-02-12).

Details

use_targets() writes an example ⁠_targets.R⁠ script to get started with a targets pipeline for the current project. Follow the comments in this script to adapt it as needed. For more information, please visit https://books.ropensci.org/targets/walkthrough.html.

Value

NULL (invisibly).

See Also

Other help: tar_reprex(), targets-package, use_targets_rmd()

Examples

if (identical(Sys.getenv("TAR_INTERACTIVE_EXAMPLES"), "true")) {
tar_dir({ # tar_dir() runs code from a temp dir for CRAN.
use_targets(open = FALSE)
})
}

targets documentation built on Oct. 3, 2024, 1:11 a.m.