Description Usage Arguments Value Public fields Methods Examples
Retrieve orderly config object.
1 | orderly_config(root = NULL, locate = TRUE)
|
root |
The path to an orderly root directory, or |
locate |
Logical, indicating if the configuration should be
searched for. If |
An R6 object representing the orderly config.
root
Root dir of the orderly repository
raw
The raw orderly config yaml
destination
DB connection configuration for where
to store orderly output database. Defaults to local SQLite
db orderly.sqlite
fields
Configuration of fields in reports, specifying which are required
remote
Configuration of remote sources i.e. shared copy of orderly on a remote machine
vault
Vault server connection information
global_resources
Path to dir containing global resources.
changelog
Changelog type configuration
tags
List of available tags for orderly reports.
database
Database configuration specifying driver and connection args for (possibly multiple) databases
archive_version
Orderly version number of the archive
run_options
List of run options
new()
Create an object representing orderly config
orderly_config_$new(root, validate = TRUE)
root
Root dir of the orderly repository
validate
If TRUE migrate cfg to handle any format changes and validate structure if well formed for each of the cfg fields
server_options()
Get connection options for the current server. This is
the details from the "remote" section for the server
being run on. Server identified via env var
ORDERLY_API_SERVER_IDENTITY
orderly_config_$server_options()
Options for current server if can be identified, otherwise NULL
add_run_option()
Add a key-value pair run option
orderly_config_$add_run_option(name, value)
name
Name of run option
value
Value for run option
get_run_option()
Retrieve value of a run option
orderly_config_$get_run_option(name)
name
Name of run option
1 2 3 4 | # The orderly demo, with lots of potential reports:
path <- orderly::orderly_example("demo")
orderly::orderly_config(path)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.