Dynamic Function-Oriented 'Make'-Like Declarative Pipelines
Assertions
List errored targets.
Check if target metadata exists.
download local metadata to the cloud.
Synchronize cloud metadata.
Upload local metadata to the cloud.
Get the name of the target currently running.
Return the vertices and edges of a pipeline dependency graph.
Use targets
Use targets with Target Markdown.
Test code in a temporary directory.
Deprecated: callr
arguments.
Objects exported from other packages
RStudio addin to call tar_glimpse()
.
RStudio addin to call tar_load()
on the symbol at the cursor.
RStudio addin to run tar_make()
in the background.
RStudio addin to call tar_outdated()
.
RStudio addin to print tail(tar_progress())
.
RStudio addin to call tar_read()
on the symbol at the cursor.
RStudio addin to insert "tar_target()"
at the cursor.
RStudio addin to call tar_visnetwork()
.
Show if the pipeline is running.
Code dependencies
Code dependencies (raw version)
Select targets using their descriptions.
Destroy the data store.
Execute code in a temporary directory.
Produce a data frame of information about your targets.
mermaid.js
dependency graph.
Read a project's metadata.
Delete metadata.
Superseded: exponential backoff
Combine pipeline objects (deprecated).
Integer branch indexes
Branch names
Branch names (raw version)
Reconstruct the branch names and the names of their dependencies.
Deprecated: list built targets.
Identify the called targets
function.
Default callr
arguments.
Invoke a targets
task from inside a callr
function (without error ...
Cancel a target mid-execution under a custom condition.
List canceled targets.
List completed targets.
Conditions
Contain an error condition and formatted traceback.
Get configuration settings.
List projects.
Set configuration settings.
Unset configuration settings.
Read _targets.yaml
.
Create a counter object.
Get crew worker info.
Declare the rules that cue a target.
Print instructions for debugging a target.
Deduplicate meta and progress databases (deprecated).
For developers only: get the definition of the current target.
Delete target output values.
List dispatched targets.
Open the target script file for editing.
Target Markdown knitr
engine
For developers only: get the environment of the current target.
Show targets
environment variables.
Check if local output data exists for one or more targets.
Check if process metadata exists.
Check if progress metadata exists.
Check if the target script file exists.
Define a custom target storage format.
Set up GitHub Actions to run a targets pipeline
Visualize an abridged fast dependency graph.
Group a data frame to iterate over subsets of rows.
Write a helper R script.
Write a helper R script (raw version).
Run if Target Markdown interactive mode is on.
Delete one or more metadata records (e.g. to rerun a target).
Language
Load the values of targets.
Load the values of all available targets.
Load globals for debugging, testing, and prototyping
Load the values of targets (raw version).
Run a pipeline of targets.
Superseded. Run a pipeline with persistent clustermq
workers.
Superseded. Run a pipeline of targets in parallel with transient `futu...
Interactive mode pipeline
List new targets
Run if Target Markdown interactive mode is not on.
List saved targets
List old targets
Export options.
Get a target option.
Reset all target options.
Set target options.
Check which targets are outdated.
Deprecated: identify the file path where a target will be stored.
Current target script path
Directory path to the support scripts of the current target script
Current data store path
Identify the file path where a target will be stored.
Emulate dynamic branching.
Get main process ID.
Declare a pipeline (deprecated).
Repeatedly poll progress in the R console.
Get main process info.
Read progress.
Tabulate the progress of dynamic branches.
Summarize target progress.
Remove targets that are no longer part of the pipeline.
List targets that tar_prune()
will remove.
Random TCP port
Read a target's value from storage.
Read a target's value from storage (raw version)
Set up package dependencies for compatibility with renv
Reproducible example of targets
with reprex
Target resources
Target resources: Amazon Web Services (AWS) S3 storage
Target resources: clustermq
high-performance computing
Target resources: crew
high-performance computing
Target resources for custom storage formats
Target resources: feather storage formats
Target resources: fst
storage formats
Target resources: future
high-performance computing
Target resources: Google Cloud Platform (GCP) Google Cloud Storage (GC...
Target resources for network file systems.
Target resources: parquet storage formats
Target resources: qs storage formats
Target resources: URL storage formats
Get the tar_runtime
object.
Write a target script file.
Deprecated: get the seed of the current target.
Create a seed for a target.
Get the random number generator seed of the target currently running.
Set a seed to run a target.
Show the cue-by-cue status of each target.
List skipped targets.
Run R scripts.
Deprecated: list started targets.
Deprecated: current data store path
Declare a target.
Define a target using unrefined names and language objects.
Get the timestamp(s) of a target.
Get the timestamp(s) of a target (raw version).
Choose code to run based on Target Markdown mode.
Get a target's traceback
Remove target script helper files.
Delete cloud object version IDs from local metadata.
Validate a pipeline of targets.
visNetwork dependency graph.
Shiny app to watch the dependency graph.
Create the full tar_watch()
app UI.
Shiny module server for tar_watch()
Shiny module UI for tar_watch()
Load a saved workspace and seed for debugging.
List saved target workspaces.
Internal function to run a target on a worker.
targets: Dynamic Function-Oriented Make-Like Declarative Pipelines for...
Pipeline tools coordinate the pieces of computationally demanding analysis projects. The 'targets' package is a 'Make'-like pipeline tool for statistics and data science in R. The package skips costly runtime for tasks that are already up to date, orchestrates the necessary computation with implicit parallel computing, and abstracts files as R objects. If all the current output matches the current upstream code and data, then the whole pipeline is up to date, and the results are more trustworthy than otherwise. The methodology in this package borrows from GNU 'Make' (2015, ISBN:978-9881443519) and 'drake' (2018, <doi:10.21105/joss.00550>).
Useful links