drake_example {drake} | R Documentation |
Download the files of an example drake
project.
![[Stable]](../help/figures/lifecycle-stable.svg)
Description
The drake_example()
function downloads a
folder from https://github.com/wlandau/drake-examples
.
By default, it creates a new folder with the example name
in your current working directory. After the files are written,
have a look at the enclosed README
file.
Other instructions are available in the files at
https://github.com/wlandau/drake-examples
.
Usage
drake_example(
example = "main",
to = getwd(),
destination = NULL,
overwrite = FALSE,
quiet = TRUE
)
Arguments
example |
Name of the example.
The possible values are the names of the folders at
|
to |
Character scalar,
the folder containing the code files for the example.
passed to the |
destination |
Deprecated; use |
overwrite |
Logical, whether to overwrite an existing folder with the same name as the drake example. |
quiet |
Logical, passed to |
Value
NULL
See Also
Examples
## Not run:
isolate_example("Quarantine side effects.", {
if (requireNamespace("downloader")) {
drake_examples() # List all the drake examples.
# Sets up the same example from load_mtcars_example()
drake_example("mtcars")
# Sets up the SLURM example.
drake_example("slurm")
}
})
## End(Not run)