set_golem_options | R Documentation |
{golem}
optionsSet and get a series of options to be used with {golem}
.
These options are found inside the golem-config.yml
file, found in most cases
inside the inst
folder.
set_golem_options( golem_name = pkgload::pkg_name(), golem_version = pkgload::pkg_version(), golem_wd = pkgload::pkg_path(), app_prod = FALSE, talkative = TRUE ) set_golem_wd(path = pkgload::pkg_path(), talkative = TRUE) set_golem_name( name = pkgload::pkg_name(), path = pkgload::pkg_path(), talkative = TRUE ) set_golem_version( version = pkgload::pkg_version(), path = pkgload::pkg_path(), talkative = TRUE ) get_golem_wd(use_parent = TRUE, path = pkgload::pkg_path()) get_golem_name( config = Sys.getenv("R_CONFIG_ACTIVE", "default"), use_parent = TRUE, path = pkgload::pkg_path() ) get_golem_version( config = Sys.getenv("R_CONFIG_ACTIVE", "default"), use_parent = TRUE, path = pkgload::pkg_path() )
golem_name |
Name of the current golem. |
golem_version |
Version of the current golem. |
golem_wd |
Working directory of the current golem package. |
app_prod |
Is the |
talkative |
Should the messages be printed to the console? |
path |
The path to set the golem working directory.
Note that it will be passed to |
name |
The name of the app |
version |
The version of the app |
use_parent |
|
config |
Name of configuration to read from. Defaults to
the value of the |
Used for side-effects for the setters, and values from the config in the getters.
set_golem_options()
sets all the options, with the defaults from the functions below.
set_golem_wd()
defaults to here::here()
, which is the package root when starting a golem.
set_golem_name()
defaults pkgload::pkg_name()
set_golem_version()
defaults pkgload::pkg_version()
Reads the information from golem-config.yml
get_golem_wd()
get_golem_name()
get_golem_version()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.