drake (version 6.2.1)

progress: Get the build progress of your targets during a make().

Description

Objects that drake imported, built, or attempted to build are listed as "finished" or "in progress". Skipped objects are not listed.

Usage

progress(..., list = character(0), no_imported_objects = FALSE,
  imported_files_only = logical(0), path = getwd(), search = TRUE,
  cache = drake::get_cache(path = path, search = search, verbose =
  verbose), verbose = drake::default_verbose(), jobs = 1)

Arguments

...

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

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. Ignored if a cache is supplied.

search

logical. If TRUE, search parent directories to find the nearest drake cache. Otherwise, look in the current working directory only. Ignored if a cache is supplied.

cache

drake cache. See new_cache(). If supplied, path and search are ignored.

verbose

logical or numeric, control printing to the console. Use pkgconfig to set the default value of verbose for your R session: for example, pkgconfig::set_config("drake::verbose" = 2).

• 0 or FALSE: print nothing.

• 1 or TRUE: print only targets to build.

• 2: also print checks and cache info.

• 3: also print any potentially missing items.

• 4: also print imports and writes to the cache.

jobs

number of jobs/workers for parallel processing

Value

The build progress of each target reached by the current make() so far.

See Also

diagnose(), drake_get_session_info(), built(), imported(), readd(), drake_plan(), make()

Examples

# NOT RUN {
test_with_dir("Quarantine side effects.", {
load_mtcars_example() # Get the code with drake_example("mtcars").
make(my_plan) # Run the project, build the targets.
# Watch the changing progress() as make() is running.
progress() # List all the targets reached so far.
progress(small, large) # Just see the progress of some targets.
progress(list = c("small", "large")) # Same as above.
progress(no_imported_objects = TRUE) # Ignore imported R objects.
})
# }