show_config: Show a configuration file

View source: R/show_config.R

show_configR Documentation

Show a configuration file

Description

Show a configuration file

Usage

show_config(path = get_config(), ...)

Arguments

path

A string giving the path to a configuration file. NULL defaults to get_config().

...

Other arguments passed to readr::read_lines(), e.g. n_max.

Value

Prints to the console the configuration file.

See Also

FINANCIAL.TIMESTAMP

Other functions to deal with configuration files: create_config(), default_config(), edit_config()

Examples

# A configuration file stored in the package
path <- default_config()
show_config(path, n_max = 10)

# Create a new configuration file to show a more general case
config_file <- glue::glue("
  default:
    a_field: a_value
")
config_path <- tempfile()
readr::write_lines(config_file, config_path)

show_config(config_path)

2DegreesInvesting/r2dii.utils documentation built on March 31, 2022, 11:20 p.m.