Read package configuration — loadConfig • OptirrigPTGE

Read default package configuration and complete it with eventual user config.

Usage

loadConfig(
  userFile = "config.yml",
  pathDefaultCfg = system.file("config.yml", package = utils::packageName()),
  ...
)

Arguments

userFile: location of the user config YML file (Use NULL or empty character to ignore)
pathDefaultCfg: The location of the default configuration (located in "inst/config.yml" of the package by default)
...: Other parameters than file sent to config::get such as config or value

Value

A configuration as it is returned by config::get

Details

User file configuration (by default the config.yml file in the working directory) can overwrite items of the default configuration (See examples).