PTBoxProxydata_reload_config: Reload the configuration for the PTBoxProxydata package

In paleovar/ptboxproxydata: The Proxy Data Manager for a consistent, efficient and reusable data workflow for (paleo) time series within the PaleoToolBox (PTBox)

Reload the configuration for the PTBoxProxydata package

Description

Reload the configuration for the PTBoxProxydata package

Usage

PTBoxProxydata_reload_config(
  config_path = get("CONFIG_PATH", .PTBoxProxydata),
  config = Sys.info()[["nodename"]]
)

Arguments

config_path	path of the changed new or old '.yml' file containing the configuration. See Warning.
config	configuration to load from the '.yml' file provided in config_path. See Details.

Value

no return

Warning

Be careful when changing the default configuration of PTBoxProxydata. This may turn your package instance to be unable to read the Master Spreadsheet temporarily. If you made changes to the default configuration file, config_path doesn't have to be supplied. However, it is recommended to test changes with a custom configuration file first before changing the configuration at it's native location. See vignette('how-to-use-sdm') as well.

Details

If config is not provided or config = 'default', will load the configuration tagged with 'default' in the config file. If custom config is provided but not complete, will always expand config with 'default' configuration from config file. Be careful when changing the 'default' configuration for your package instance (See Warning and vignette('PTBoxProxydata_howto')).

See also

PTBoxProxydata_print_config, PTBoxProxydata_print_config_path

Examples

## Not run: 
# print current config path
PTBoxProxydata_print_config_path()
# set a config file
new_config_file <- 'my/new/config/path/PTBoxProxydata-config.yml'
PTBoxProxydata_reload_config(config_path = new_config_file,
                             config = 'my_machine')

## End(Not run)

paleovar/ptboxproxydata documentation built on June 1, 2022, 1:12 a.m.