aqueduct_setup: Set up aqueduct workflow

In harveybarnhard/aqueduct: What the Package Does (One Line, Title Case)

Description

This function establishes filepaths that are to be used in an aqueduct workflow by defining the filepaths and their names. Shorter names make more readable workflows. These filepaths are stored in a hidden aqueduct environment to avoid clutter (an environment that is established in this folder)

Usage

aqueduct_setup(
  basepath = "",
  ...,
  projname = "aqueduct",
  update = FALSE,
  archive = FALSE
)

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
update	logical; FALSE by default. If FALSE, then a new environment is created and any previous filepaths are erased. If TRUE then any filepaths given will be added to the list of previous filepaths
archive	logical; FALSE by default. If FALSE then it is assumed that aqueduct_setup() is updating filepaths. If TRUE and a basepath is given, then any previous aqueduct caches are archived

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