R/tar_call.R

Defines functions tar_call

Documented in tar_call

#' @title Identify the called `targets` function.
#' @export
#' @family utilities
#' @description Get the name of the currently running `targets`
#'   interface function. Returns `NULL` if not invoked inside
#'   a target or `_targets.R` (i.e. if not directly invoked
#'   by [tar_make()], [tar_visnetwork()], etc.).
#' @return Character of length 1, name of the currently running `targets`
#'   interface function. For example, suppose you have a call to
#'   `tar_call()` inside a target or `_targets.R`. Then if you run
#'   `tar_make()`, `tar_call()` will return `"tar_make"`.
#' @examples
#' if (identical(Sys.getenv("TAR_EXAMPLES"), "true")) { # for CRAN
#' tar_dir({ # tar_dir() runs code from a temp dir for CRAN.
#' tar_call() # NULL
#' tar_script({
#'   message("called function: ", tar_call())
#'   tar_target(x, tar_call())
#' })
#' tar_manifest() # prints "called function: tar_manifest"
#' tar_make() # prints "called function: tar_make"
#' tar_read(x) # "tar_make"
#' })
#' }
tar_call <- function() {
  tar_runtime$fun
}

Try the targets package in your browser

Any scripts or data that you put into this service are public.

targets documentation built on May 29, 2024, 11:16 a.m.