aqueduct_initial: Initial setup of an aqueduct workflow

Description Usage Arguments

View source: R/aqueduct_initial.R

Description

Helper function for aqueduct_setup()

Usage

1
aqueduct_initial(basepath, ..., projname)

Arguments

basepath

Character string; directory in which you want the aqueduct files to be located, provided as an exact formula (see entry below). If update=TRUE then this parameter need not be provided.

...

Filepath formulas, separated by commas. There are two kinds of formulas. An exact formula should be given as a string. These work best for establishing the basepaths from the root of your system from which all other paths are derived. For example,

basepath = "C:/Users/example_user"

The formulas may also be given as relative paths, where the first level is derived from previously defined filepaths. For example,

datapath ~ basepath/data/raw

which would correspond to "C:/Users/example_user/data/raw"

projname

Character string; "aqueduct" by default. The informative name you want to give to the aqueduct workflow project. The choice of this parameter has little practical implications other than to make statements printed from aqueduct() more informative


harveybarnhard/aqueduct documentation built on Jan. 1, 2021, 3:15 a.m.