R/create_config.R

Defines functions create_config

Documented in create_config

#' Create a configuration file
#'
#' @param ... String(s) to pass to the `...` argument of [glue::glue()].
#' @param path String giving the path where to save the configuration file.
#'
#' @family functions to deal with configuration files
#' @seealso [FINANCIAL.TIMESTAMP]
#'
#' @return Invisible `path`.
#' @export
#'
#' @examples
#' out <- create_config("
#'   default:
#'     field: value
#' ")
#' out
#'
#' show_config(out)
create_config <- function(..., path = fs::file_temp("config-", ext = ".yml")) {
  ellipsis::check_dots_used()

  readr::write_lines(glue::glue(...), path = path)
  usethis::ui_done("Saved to {usethis::ui_path(path)}.")

  invisible(path)
}
2DegreesInvesting/r2dii.utils documentation built on Jan. 23, 2020, 1:38 a.m.