drake (version 4.4.0)

load_basic_example: Function load_basic_example

Description

Loads the basic example into your workspace (or the environment you specify). Also writes/overwrites the file report.Rmd. For a thorough walkthrough of how to set up this example, see the quickstart vignette: vignette('quickstart'). Alternatively, call example_drake('basic') to generate an R script that builds up this example step by step.

Usage

load_basic_example(envir = parent.frame(), report_file = "report.Rmd",
  overwrite = FALSE, to = report_file)

Arguments

envir

The environment to load the example into. Defaults to your workspace. For an insulated workspace, set envir = new.env(parent = globalenv()).

report_file

where to write the report file report.Rmd.

overwrite

logical, whether to overwrite an existing file report.Rmd

to

deprecated, where to write the dynamic report source file report.Rmd

Examples

# NOT RUN {
load_basic_example()
deps(reg1)
deps(my_plan$command[1])
deps(my_plan$command[4])
plot_graph(my_plan)
make(my_plan)
clean(destroy = TRUE)
unlink('report.Rmd')
# }