scmake: Wrapper for remake::make that permits cache sharing

View source: R/scmake.R

scmakeR Documentation

Wrapper for remake::make that permits cache sharing

Description

The name: sc=scipiper, sc=shared cache. This wrapper could eventually involve other custom hooks for things to do before or after building a target

Usage

scmake(
  target_names = NULL,
  remake_file = getOption("scipiper.remake_file"),
  ...,
  force = FALSE,
  verbose = TRUE,
  allow_missing_packages = FALSE,
  ind_ext = getOption("scipiper.ind_ext")
)

Arguments

target_names

as in remake::make

remake_file

the file path+name of the remake file to use in building the targets. As in remake::make, except that for scmake this param comes before ... and second in line, so it can be easily specified without naming the argument

...

as in remake::make

force

logical. if TRUE, the target_names will be deleted with scdel before being built.

verbose

as in remake::make

allow_missing_packages

as in remake::make

ind_ext

the indicator file extension identifying those files for which build/status information will be shared via git-committable files in the build/status folder. You should git commit the resulting build/status files.


USGS-R/scipiper documentation built on May 25, 2023, 8:47 a.m.