Create, Read the Directory Configuration File — directory_configuration

The directory configuration file is a special file within the forecasting directory setup and has its own set of functions.

write_directory_config creates the YAML metadata configuration file. It is (and should only be) called from within setup_dir, as it captures information about the compute environment used to instantiate the directory.

write_directory_config(
  main = ".",
  settings = directory_settings(),
  quiet = FALSE
)

read_directory_config(
  main = ".",
  settings = directory_settings(),
  quiet = FALSE
)

Arguments

main: character value of the name of the main component of the directory tree. Default value (".") puts the forecasting directory in the present locations. Nesting the forecasting directory in a folder can be done by simply adding to the main input.
settings: list of controls for the directory, with defaults set in directory_settings that should generally not need to be altered.
quiet: logical indicator if progress messages should be quieted.

Value

list of directory configurations, invisible-ly.