drake (version 5.2.1)

load_basic_example: Deprecated function load_basic_example

Description

Use load_mtcars_example() instead.

Usage

load_basic_example(envir = parent.frame(), seed = NULL, cache = NULL,
  report_file = "report.Rmd", overwrite = FALSE, to = report_file,
  verbose = drake::default_verbose(), force = FALSE)

Arguments

envir

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

seed

integer, the root pseudo-random seed to use for your project. To ensure reproducibility across different R sessions, set.seed() and .Random.seed are ignored and have no affect on drake workflows. Conversely, make() does not change .Random.seed, even when pseudo-random numbers are generated.

On the first call to make() or drake_config(), drake uses the random number generator seed from the seed argument. Here, if the seed is NULL (default), drake uses a seed of 0. On subsequent make()s for existing projects, the project's cached seed will be used in order to ensure reproducibility. Thus, the seed argument must either be NULL or the same seed from the project's cache (usually the .drake/ folder). To reset the random number generator seed for a project, use clean(destroy = TRUE).

cache

Optional storr cache to use.

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

verbose

logical or numeric, control printing to the console. Use pkgconfig to set the default value of verbose for your R session: for example, pkgconfig::set_config("drake::verbose" = 2).

0 or FALSE:

print nothing.

1 or TRUE:

print only targets to build.

2:

in addition, print checks and cache info.

3:

in addition, print any potentially missing items.

4:

in addition, print imports. Full verbosity.

force

logical, whether to force the loading of a non-back-compatible cache from a previous version of drake.

Value

A config list, as in load_mtcars_example().

Details

Deprecated on 2018-04-21.

See Also

load_mtcars_example()

Examples

# NOT RUN {
# See ?load_mtcars_example for examples.
# }