Skip to contents

The catalog records one row per job type, including templates still queued or blocked on functions in other packages. template_list() reports the files already shipped; this catalog records the full work plan.

Usage

template_catalog()

Value

A data frame. uses, upstream, downstream, and workflows are list columns of character vectors. Unmeasured counts are NA_integer_. description is a one-sentence summary, given for every template on disk and NA for most queued ones. deprecated_by names the template replacing a deprecated one, such as "dc-gfup", and deprecation_note says how to move to it; both are NA for a supported template. A deprecated template still ships, and add_job warns when it is used.

Examples

catalog <- template_catalog()
table(catalog$status)
#> 
#> in-flight    queued   revisit   shipped 
#>         3        30         1        34 

# Templates that still scaffold but name a replacement.
catalog[!is.na(catalog$deprecated_by), c("prefix", "qualifier", "deprecated_by")]
#> [1] prefix        qualifier     deprecated_by
#> <0 rows> (or 0-length row.names)

# Queued templates waiting on work in another package.
queued <- catalog[catalog$status == "queued" & !is.na(catalog$blocked_on), ]
queued[, c("prefix", "qualifier", "blocked_on")]
#>    prefix qualifier        blocked_on
#> 8      bq      <NA> hvtiRbootstrap#16
#> 11     ce      <NA>     hvtiPlotR#134
#> 13     cp      <NA>     hvtiPlotR#135
#> 14     dt      <NA>    hvtiRdatabuild
#> 15     fp      <NA>     hvtiPlotR#133
#> 17     gp      <NA>     hvtiPlotR#136
#> 49   vars      <NA>    hvtiRdatabuild
#> 51     mi      <NA>   hvtiRimputation
#> 56    sid      <NA>    hvtiRforests#1
#> 57     vt      <NA>    hvtiRforests#1