R/make_prior_config.R

In tjthurman/BAHZ: Bayesian Analysis of Hybrid Zones

#' Make a prior configuration file
#'
#' Makes a configuration file which you can use to specify the priors for your
#' hybrid zone analysis. By default, creates the file in the working directory
#' with the name \code{prior_config_template.yaml}. You can supply a filepath
#' and a different name if you want to save the file somewhere else or with a
#' different name. It will not overwrite files by default, you must set overwrite =
#' T to do that.
#'
#'
#' @param path The folder where you wish to save the prior configuration file.
#'   The default is the current working directory.
#' @param name The name you want to give the prior configuration file. The
#'   default is \code{prior_config_template.yaml}. File name must end in \code{.yaml}.
#' @param overwrite Do you want to overwrite existing files?
#'   \code{TRUE} or \code{FALSE}, default is \code{FALSE}.
#'
#' @return \code{invisible(NULL)}
#'
#' @export
#'
#' @examples
#' \dontrun{
#' # Make config file in current working directory with default name.
#' # Won't overwrite
#' make_prior_config()
#'
#' # Make config file in a different folder with a new name.
#' # Will overwrite an existing file.
#' make_prior_config(path = "/path/to/directory", name = "my_priors.yaml", overwrite = T)
#' }
#'

make_prior_config <- function(path = getwd(),
                                  name = "prior_config_template.yaml",
                                  overwrite = F) {
  # Argument checking
  assertthat::assert_that(length(name) == 1, msg = "name must be of length 1")
  assertthat::assert_that(is.character(name) == T, msg = "name must be a character string")
  assertthat::assert_that(stringr::str_detect(name, pattern = "\\.yaml$") == 1, msg = "name must end in .yaml")
  assertthat::assert_that(is.logical(overwrite) == T, msg = "overwrite must be either TRUE (T) or FALSE (F)")


  newfile <- file.path(normalizePath(path), name, fsep = .Platform$file.sep)
  if (overwrite == F) { # If overwriting is not allowed
    if (file.exists(newfile) == T) { # Stop if file exists
      stop("Template file already exists, set overwrite = T if you want to overwrite it")
    }
    else {
      file.copy(from = system.file("extdata", "prior_config_template.yaml", package = "bahz", mustWork = TRUE),
                to = newfile,
                overwrite = overwrite)
    }
  }
  else { # If overwriting is allowed
    if (file.exists(newfile) == T) { # Notify when overwriting
      message(paste0(name, " alrady exists, overwriting"))
      file.copy(from = system.file("extdata", "prior_config_template.yaml", package = "bahz", mustWork = TRUE),
                to = newfile,
                overwrite = overwrite)
    } else {
      file.copy(from = system.file("extdata", "prior_config_template.yaml", package = "bahz", mustWork = TRUE),
                to = newfile,
                overwrite = overwrite)
    }
  }
  if (file.exists(newfile) == T) {
    message("Configuration file successfully generated")
  } else {
    stop("Configuration file not generated")
  }
  return(invisible(NULL))
}