R/lum_create_site_model_arg.R

Defines functions lum_create_site_model_arg

Documented in lum_create_site_model_arg

#' Create the \code{site_model} argument
#' @inheritParams default_params_doc
#' @author Richèl J.C. Bilderbeek
#' @export
lum_create_site_model_arg <- function(
  subst_model = "JC69",
  gamma_site_model = beautier::create_gamma_site_model()
) {
  lum_create_gamma_site_model_arg <- NULL; rm(lum_create_gamma_site_model_arg) # nolint, fixes warning: no visible binding for global variable
  if (!beautier::is_gamma_site_model(gamma_site_model)) {
    stop(
      "'gamma_site_model' must be a gamma site model.\n",
      "Actual value(s): ", gamma_site_model
    )
  }
  site_model_arg <- lum_create_gamma_site_model_arg(gamma_site_model)
  arg <- "site_model = "
  if (subst_model == "JC69") {
    return(paste0(arg, "create_jc69_site_model(", site_model_arg, ")"))
  }
  if (subst_model == "HKY") {
    return(paste0(arg, "create_hky_site_model(", site_model_arg, ")"))
  }
  if (subst_model == "TN93") {
    return(paste0(arg, "create_tn93_site_model(", site_model_arg, ")"))
  }
  if (subst_model == "GTR") {
    return(paste0(arg, "create_gtr_site_model(", site_model_arg, ")"))
  }
  stop("Unknown substitution model")
}
richelbilderbeek/lumier documentation built on March 13, 2021, 10:20 p.m.