R/freq_param_to_xml.R

In richelbilderbeek/beastscriptr: 'BEAUti' from R

#' Internal function
#'
#' Converts a `freq` parameter to XML
#' @inheritParams default_params_doc
#' @return the parameter as XML text
#' @examples
#' check_empty_beautier_folder()
#'
#' # The freq parameter must be initialized, i.e. have an ID
#' freq_param_to_xml(freq_param = create_freq_param(id = "1"))
#'
#' check_empty_beautier_folder()
#' @author Richèl J.C. Bilderbeek
#' @export
freq_param_to_xml <- function(
  freq_param,
  beauti_options = create_beauti_options()
) {
  check_beauti_options(beauti_options)
  check_true(is_freq_param(freq_param))
  id <- freq_param$id
  check_true(is_id(id))

  xml <- paste0("<parameter id=\"freqParameter.s:", id, "\" ")
  if (beauti_options$beast2_version == "2.6") {
    xml <- paste0(
      xml,
      "spec=\"parameter.RealParameter\" "
    )
  }
  xml <- paste0(
    xml,
    "dimension=\"", freq_param$dimension, "\" ",
    "lower=\"", freq_param$lower, "\" ",
    "name=\"stateNode\" ",
    "upper=\"", freq_param$upper, "\">",
    freq_param$value,
    "</parameter>"
  )
  xml
}