sourceTAF: Run TAF Script

Description

Run a TAF script and return to the original directory.

Usage

sourceTAF(script, rm = FALSE, clean = TRUE, detach = FALSE, taf = NULL,
  quiet = FALSE)

Value

TRUE or FALSE, indicating whether the script ran without errors.

Arguments

script: script filename.
rm: whether to remove all objects from the global environment before and after the script is run.
clean: whether to clean the target directory before running the script.
detach: whether to detach all non-base packages before running the script, to ensure that the script is not affected by packages that may have been attached outside the script.
taf: a convenience flag where taf = TRUE sets rm, clean, and detach to TRUE, as is done on the TAF server. Any other value of taf is ignored.
quiet: whether to suppress messages reporting progress.

Details

The default value of rm = FALSE is to protect users from accidental loss of work, but the TAF server always runs with rm = TRUE to make sure that only files, not objects, are carried over between scripts.

Likewise, the TAF server runs with clean = TRUE to make sure that the script starts with a clean directory. The target directory of a TAF script has the same filename prefix as the script: data.R creates data etc.

Examples

Run this code

if (FALSE) {
write("print(pi)", "script.R")
source("script.R")
sourceTAF("script.R")
file.remove("script.R")
}