Copy a simple orderly example — orderly_example • orderly2

Copy a simple orderly example for use in the docs. This function should not form part of your workflow!

Usage

orderly_example(name, ..., dest = NULL)

Arguments

name: The name of the example to copy. Currently only "default" is supported.
...: Arguments passed through to orderly_init()
dest: The destination. By default we use withr::local_tempfile() which will create a temporary directory that will clean itself up. This is suitable for use from the orderly examples, but you may prefer to provide your own path. The path must not already exist.

Value

Invisibly, the path to the example.

Examples

path <- orderly2::orderly_example("default")
#> ✔ Created orderly root at '/tmp/RtmprnCT52/file17162ca10a75'
orderly2::orderly_list_src(root = path)
#> Error in orderly_src_root(root, locate): Directory does not exist: '/tmp/RtmprnCT52/file17162ca10a75'