orderly_run_info | R Documentation |
This function allows inspection of some of orderly's metadata
during an orderly run. The format returned is internal to orderly
and subject to change. It is designed to be used within report
code. To use in conjunction with
orderly_test_start()
, you must pass in the path to the
report in question.
orderly_run_info(path = NULL)
path |
Path to the report currently being run. This should
be left as |
A list of metadata about the current report
It is important that this data is treated as readonly!
path <- orderly::orderly_example("demo")
# This example uses orderly_run_info within its script, saving the
# output to "output.rds"
readLines(file.path(path, "src", "use_dependency", "script.R"))
# Run the dependency:
id <- orderly::orderly_run("other", list(nmin = 0), root = path)
orderly::orderly_commit(id, root = path)
# Then the report
id <- orderly::orderly_run("use_dependency", root = path)
# This is the contents:
readRDS(file.path(path, "draft", "use_dependency", id, "info.rds"))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.