Crunch automation is a custom scripting syntax that allows you to concisely describe the metadata of your data when importing. The syntax is described in the crunch API documentation
runCrunchAutomation(
dataset,
script,
is_file = string_is_file_like(script),
encoding = "UTF-8",
...
)
showScriptErrors()
A crunch dataset
A path to a text file with crunch automation syntax or a string the syntax loaded in R.
The default guesses whether a file or string was
used in the script
argument, but you can override the heuristics
by specifying TRUE
for a file, and FALSE
for a string.
Optional encoding to convert from, defaults to UTF-8. The API accepts only UTF-8, so all text will be converted to UTF-8 before being sent to the server.
Additional options, such as dry_run = TRUE
passed on
to the API
For runCrunchAutomation()
: an updated dataset (invisibly),
For showScriptErrors()
, when run after a failure, a list with two items:
script
: that contains the script string sent to the server and errors
which is a
data.frame
with details about the errors sent from the server.
if (FALSE) {
# Can use a path to a file:
script_file <- "crunch_automation.txt"
ds <- runCrunchAutomation(ds, script_file)
# Or a string directly:
ds <- runCrunchAutomation(ds, "RENAME v1 TO age;")
# A "dry run" that validates the script but does not run it:
runCrunchAutomation(ds, "RENAME V1 TO age;", dry_run = TRUE)
# After a failed run, some error information prints to console,
# But more details are available with function:
showScriptErrors()
# After a successful run, can look at scripts
scripts(ds)
}