list_all_targets: Get a list of all targets in a remake file

Description Usage Arguments Value Examples

View source: R/scmake.R

Description

Get a list of all targets in a remake file

Usage

1
2
list_all_targets(remake_file = getOption("scipiper.remake_file"),
  recursive = FALSE)

Arguments

remake_file

filename of the remake YAML file from which targets should be collected

recursive

logical. if TRUE, result will include all targets from any YAMLs listed in the include: section of the given remake_file, or any YAMLs listed in the include: sections of those included YAMLs, etc.

Value

vector of all target names explicitly declared in this remake_file (and if recursive=TRUE, also the names of targets declared in remake files included by this remake_file)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# assuming you have a file named remake.yml:
list_all_targets() # get status for all explicitly named targets in remake.yml

# status for all targets in a different remake YAML:
list_all_targets('other_remake.yml')

# status for all targets in remake.yml and any remake YAMLs included by remake.yml
list_all_targets(recursive=TRUE)

## End(Not run)

USGS-R/scipiper documentation built on Aug. 14, 2018, 5:23 a.m.