Help

targets-package

targets: Dynamic Function-Oriented Make-Like Declarative Pipelines for R

use_targets()

Use targets

Scripts

tar_edit()

Open the target script file for editing.

tar_github_actions()

Set up GitHub Actions to run a targets pipeline

tar_helper()

Write a helper R script.

tar_helper_raw()

Write a helper R script (raw version).

tar_renv()

Set up package dependencies for compatibility with renv

tar_script()

Write a target script file.

Configuration

tar_config_get()

Get configuration settings from _targets.yaml.

tar_config_set()

Write configuration settings to _targets.yaml.

tar_envvars()

Show environment variables to customize targets

tar_option_get()

Get a target option.

tar_option_reset()

Reset all target options.

tar_option_set()

Set target options.

Targets

tar_cue()

Declare the rules that cue a target.

tar_target()

Declare a target.

tar_target_raw()

Define a target using unrefined names and language objects.

Pipeline

tar_make()

Run a pipeline of targets.

tar_make_clustermq()

Run a pipeline of targets in parallel with persistent clustermq workers.

tar_make_future()

Run a pipeline of targets in parallel with transient future workers.

Debug

tar_load_globals()

Load globals for debugging, testing, and prototyping

tar_traceback()

Get a target's traceback

tar_workspace()

Load a saved workspace and seed for debugging.

tar_workspaces()

List saved target workspaces.

Data

tar_load()

Load the values of targets.

tar_load_raw()

Load the values of targets (raw version).

tar_meta()

Read a project's metadata.

tar_objects()

List saved targets

tar_pid()

Get main process ID.

tar_process()

Get main process info.

tar_read()

Read a target's value from storage.

tar_read_raw()

Read a target's value from storage (raw version)

Inspect

tar_deps()

Code dependencies

tar_deps_raw()

Code dependencies (raw version)

tar_manifest()

Produce a data frame of information about your targets.

tar_glimpse()

Visualize an abridged fast dependency graph.

tar_network()

Return the vertices and edges of a pipeline dependency graph.

tar_outdated()

Check which targets are outdated.

tar_sitrep()

Show the cue-by-cue status of each target.

tar_visnetwork()

Visualize an abridged fast dependency graph.

tar_validate()

Validate a pipeline of targets.

Clean

tar_delete()

Delete locally stored target return values.

tar_destroy()

Destroy all or part of the data store.

tar_invalidate()

Invalidate targets and global objects in the metadata.

tar_prune()

Remove targets that are no longer part of the pipeline.

tar_unscript()

Remove target script helper files.

Progress

tar_poll()

Repeatedly poll progress in the R console.

tar_progress()

Read progress.

tar_progress_branches()

Tabulate the progress of dynamic branches.

tar_progress_summary()

Summarize target progress.

tar_watch()

Shiny app to watch the dependency graph.

tar_watch_server()

Shiny module server for tar_watch()

tar_watch_ui()

Shiny module UI for tar_watch()

Time

tar_newer()

List new targets

tar_older()

List old targets

tar_timestamp()

Get the timestamp(s) of a target.

tar_timestamp_raw()

Get the timestamp(s) of a target (raw version).

Existence

tar_exist_meta()

Check if target metadata exists.

tar_exist_objects()

Check if local output data exists for one or more targets.

tar_exist_process()

Check if process metadata exists.

tar_exist_progress()

Check if progress metadata exists.

tar_exist_script()

Check if the target script file exists.

Branching

tar_branch_index()

Integer branch indexes

tar_branches()

Reconstruct the branch names and the names of their dependencies.

tar_pattern()

Emulate dynamic branching.

Resources

tar_resources()

Target resources

tar_resources_aws()

Target resources: AWS storage formats

tar_resources_clustermq()

Target resources: clustermq high-performance computing

tar_resources_feather()

Target resources: feather storage formats

tar_resources_fst()

Target resources: fst storage formats

tar_resources_future()

Target resources: future high-performance computing

tar_resources_parquet()

Target resources: parquet storage formats

tar_resources_qs()

Target resources: qs storage formats

tar_resources_url()

Target resources: URL storage formats

Runtime

tar_cancel()

Cancel a target mid-build under a custom condition.

tar_envir()

For developers only: get the environment of the current target.

tar_group()

Group a data frame to iterate over subsets of rows.

tar_name()

Get the name of the target currently running.

tar_path()

Identify the file path where a target will be stored.

tar_seed()

Get the random number generator seed of the target currently running.

Engines

tar_engine_knitr()

Target Markdown knitr engine

Extending targets

tar_assert_chr() tar_assert_dbl() tar_assert_df() tar_assert_equal_lengths() tar_assert_envir() tar_assert_expr() tar_assert_flag() tar_assert_function() tar_assert_ge() tar_assert_identical() tar_assert_in() tar_assert_not_dirs() tar_assert_not_dir() tar_assert_not_in() tar_assert_inherits() tar_assert_int() tar_assert_internet() tar_assert_lang() tar_assert_le() tar_assert_list() tar_assert_lgl() tar_assert_name() tar_assert_names() tar_assert_nonempty() tar_assert_not_expr() tar_assert_nzchar() tar_assert_package() tar_assert_path() tar_assert_match() tar_assert_nonmissing() tar_assert_positive() tar_assert_scalar() tar_assert_target() tar_assert_target_list() tar_assert_true() tar_assert_unique() tar_assert_unique_targets()

Assertions

tar_message_run() tar_throw_file() tar_throw_run() tar_throw_validate() tar_warn_deprecate() tar_warn_run() tar_warn_validate()

Conditions

tar_deparse_language() tar_deparse_safe() tar_tidy_eval() tar_tidyselect_eval()

Language

tar_dir()

Execute code in a temporary directory.

tar_test()

Test code in a temporary directory.