workflow: Function 'workflow'

Description Usage Arguments Details See Also

View source: R/ui.R

Description

Write and execute a Makefile to run a remake workflow. Use the help_remakeGenerator function to get more help.

Usage

1
2
3
4
workflow(targets = NULL, make_these = "all", sources = NULL,
  packages = NULL, remakefile = "remake.yml", makefile = NULL,
  prepend = NULL, begin = NULL, clean = NULL, remake_args = list(verbose
  = TRUE), run = TRUE, command = "make", args = character(0))

Arguments

targets

YAML-like list of targets, which you can generate by supplying data frames of remake commands to the targets function.

make_these

names of the remake targets to makle

sources

Character vector of R source files or their containing folders.

packages

Character vector of packages

remakefile

Character, name of the remake file to generate. Should be in the current working directory.

makefile

Deprecated. The name of the Makefile will always be 'Makefile'.

prepend

Character vector of lines to prepend to the Makefile

begin

Use "prepend" instead.

clean

Deprecated. The Makefile is no longer stand alone, so it does not need 'clean'. Use remake::make("clean").

remake_args

Fully-named list of additional arguments to remake::make. You cannot set target_names or remake_file this way because those names are reserved.

run

logical, whether to actually run the Makefile or just write it.

command

character scalar, command to run to execute the Makefile. command and args will be used to call system2(command = command, args = args) to run the Makefile. For example, to execute the Makefile using 4 parallel jobs while suppressing output to the console, use makefile(..., command = "make", args = c("--jobs=4", "-s")). Passing command = NULL or command = character(0) will generate the yaml file and not run a command.

args

character vector of arguments to the specified command. command and args will be used to call system2(command = command, args = args) to run the Makefile. For example, to execute the Makefile using 4 parallel jobs while suppressing output to the console, use makefile(..., command = "make", args = c("--jobs=4", "-s")).

Details

Use the help_remakeGenerator function to get more help.

See Also

help_remakeGenerator


wlandau/remakeGenerator documentation built on May 4, 2019, 8:44 a.m.