Build an example CLUE scene — clue_example • clueRIO

This function helps setting up an example scene with custom properties.

Usage

clue_example(path = NULL, until = NULL, verbose = FALSE)

Arguments

path: character(1)
The scene has by default the root directory tempdir(), but if you want it in a particular location, specify that in this argument.
until: character(1)
The step until which the scene shall be built, one of ...,
verbose: logical(1)
be verbose about building the example scene (default FALSE).

Value

No return value, called for the side effect of creating an example scene at the specified path.

Examples

if(dev.interactive()){
# to build the full example database
clue_example(path = paste0(tempdir(), "/myScene"))

# to make the example database until a certain step
clue_example(path = paste0(tempdir(), "/myScene"), until = "")

}