configuration_file: Configuration file creation and management

View source: R/configuration_file.R

configuration_fileR Documentation

Configuration file creation and management

Description

Create or apply a configuration file (YAML extension).

Usage

configuration_file(path_file = NULL, silent = FALSE)

Arguments

path_file

character expected. Path to a existent configuration file. The file need a .yml extension. By default the parameter is NULL and the function will create a new configuration file.

silent

logical expected. Display or not information when you run an existing configuration file. By default FALSE.

Value

Return a R list with several information configuration and, if you want, a YAML file.

Examples

# If you want to create a new configuration file
## Not run: 
configuration_file()
## End(Not run)
# If you want to use an existing configuration file
## Not run: 
configuration_file(path_file = "path_of_your_own_configuration_file")
## End(Not run)

OB7-IRD/furdeb documentation built on April 21, 2024, 12:17 a.m.