Undo behavior of a Crunch Automation Script

Source: R/AllGenerics.R, R/automation.R

There are two ways to revert the output of a script:

  • undoScript() - A "softer" delete of a script's created artifacts and variables, or

  • revertScript() - A "harder" revert that returns the dataset to the state it was before running such script.

undoScript(dataset, x)

revertScript(dataset, x)

scriptSavepoint(x)

# S4 method for CrunchDataset,Script
undoScript(dataset, x)

# S4 method for CrunchDataset,ANY
undoScript(dataset, x)

# S4 method for CrunchDataset,Script
revertScript(dataset, x)

# S4 method for CrunchDataset,ANY
revertScript(dataset, x)

# S4 method for Script
scriptSavepoint(x)

Arguments

dataset

A CrunchDataset

x

A Script or index for a ScriptCatalog (generally a number)

Value

For undoScript() and revertSctipt(), invisibly return the updated dataset. For scriptSavePoint() a version list object that can be used in restoreVersion().

Details

The difference between both is that a hard revert restores the dataset, as it drops all ensuing scripts and their output (artifacts and variables), while an undo only deletes the artifacts and variables created by this script, but changes made by other scripts and this script's record will remain in place.

The function scriptSavepoint() gets the version object