R/utils.R

Defines functions get_example_config

Documented in get_example_config

#' Reads example yaml from disk
#'
#' @return output from[yaml::read_yaml()]
#' @export
#'
#' @examples
#' # config file content
#' fn <- system.file("extdata", "rf_config.yml", package = "rOstluft.rmweather", mustWork = TRUE)
#' cat(readr::read_file(fn))
#'
#'
#' # get the parsed yaml file
#' get_example_config()

get_example_config <- function() {
  yaml::read_yaml(system.file("extdata", "rf_config.yml", package = "rOstluft.rmweather", mustWork = TRUE))
}
ugzvot/rOstluft.rmweather documentation built on May 5, 2020, 9:27 a.m.