drake (version 4.2.0)

status: Deprecated function status

Description

Use progress() instead. Gets the build progress (overall or individual targets) of the last call to make(). Objects that drake imported, built, or attempted to build are listed as "finished" or "in progress". Skipped objects are not listed.

Usage

status(..., list = character(0), no_imported_objects = FALSE,
  imported_files_only = logical(0), path = getwd(), search = TRUE)

Arguments

...

objects to load from the cache, as names (unquoted) or character strings (quoted). Similar to ... in remove(...).

list

character vector naming objects to be loaded from the cache. Similar to the list argument of remove().

no_imported_objects

logical, whether to only return information about imported files and targets with commands (i.e. whether to ignore imported objects that are not files).

imported_files_only

logical, deprecated. Same as no_imported_objects. Use the no_imported_objects argument instead.

path

Root directory of the drake project, or if search is TRUE, either the project root or a subdirectory of the project.

search

If TRUE, search parent directories to find the nearest drake cache. Otherwise, look in the current working directory only.

Value

Either the build progress of each target given (from the last call to make() or make()), or if no targets are specified, a data frame containing the build progress of the last session. In the latter case, only finished targets are listed.

Either a named logical indicating whether the given targets or cached or a character vector listing all cached items, depending on whether any targets are specified

See Also

progress, built, imported, readd, plan, make

Examples

# NOT RUN {
load_basic_example()
make(my_plan)
status() # Deprecated. Use progress() instead.
status(small, large)
status(list = c("small", "large"))
status(no_imported_objects = TRUE)
# }