R/get_param_bounds.R

In SticsRPacks/SticsRFiles: Read and Modify 'STICS' Input/Output Files

#' @title Getting parameters bounds from an xml_document object
#'
#' @description Extracting parameters min and/or max bounds for a parameter
#' or a vector of parameters from an xml_document class object.
#'
#' @param xml_doc an xml_document class object
#' @param param_name a parameter name of a vector of parameters names
#' @param bounds_name bounds name "min" or "max"
#' (optional, default value c("min","max ))
#' @param output Output data format either "list" or "data.frame" (default)
#'
#' @return A data.frame with the name of the parameter and min, max values or
#' one of them. Or a named list (with parameter name) containing a named vector
#' for bounds.
#'
#' @examples
#' \dontrun{
#' xml_sta <- file.path(get_examples_path(file_type = "xml"), "file_sta.xml")
#'
#' sta_doc <- xmldocument(xml_sta)
#'
#' par_bounds <- get_param_bounds(sta_doc, "zr")
#'
#' par_bounds_list <- get_param_bounds(
#'   sta_doc,
#'   c("zr", "altistation")
#' )
#'
#'
#' get_param_bounds(sta_doc, c("zr", "altistation"), "min")
#' }
#'
#' @keywords internal
#'
#' @noRd
#'
get_param_bounds <- function(
    xml_doc,
    param_name,
    bounds_name = NULL,
    output = "data.frame") {
  def_names <- c("min", "max")

  df_out <- output == "data.frame"

  # Just in case ...get unique bounds names
  bounds_name <- unique(bounds_name)

  if (base::is.null(bounds_name)) {
    bounds_name <- def_names
  } else if (!all(is.element(bounds_name, def_names))) {
    stop("Names are not consitent with file bound names")
  }

  if (length(param_name) > 1) {
    bounds_list <- lapply(
      as.list(param_name),
      function(x) {
        get_param_bounds(
          xml_doc = xml_doc,
          x,
          bounds_name = bounds_name,
          output = output
        )
      }
    )

    if (df_out) {
      bounds_list <- dplyr::bind_rows(bounds_list)
    } else {
      bounds_list <- unlist(bounds_list, recursive = FALSE)
    }

    return(bounds_list)
  }

  param_type <- get_param_type(xml_doc, param_name)
  exist_param <- !base::is.null(param_type$xpath)

  if (!exist_param) {
    return(NULL)
  }

  xpath <- param_type$xpath

  # for an option parameter, getting
  if (param_type$type == "option") {
    xpath <- paste0(xpath, "/choix")
    tmp_values <- as.numeric(get_attrs_values(xml_doc, xpath, "code"))
    bounds_values <- c(
      min(tmp_values),
      max(tmp_values)
    )[def_names == bounds_name]
  } else {
    # for all other parameters ?
    # Adding unique for repeated parameters : for exmaple in sols.xml
    bounds_values <- lapply(
      bounds_name,
      function(x) as.numeric(get_attrs_values(xml_doc, xpath, x))
    )
  }

  # Fixing bounds values
  bounds_values <- list(fix_bounds(bounds_values, bounds_name, param_name))
  names(bounds_values) <- param_name

  # For returning a data.frame
  if (df_out) {
    bounds_values <- t(as.data.frame(bounds_values))
    bounds_values <- data.frame(
      name = param_name,
      bounds_values,
      stringsAsFactors = FALSE
    )
    rownames(bounds_values) <- NULL
  }

  return(bounds_values)
}

fix_bounds <- function(values, bounds_name, param_name) {
  values <- fix_dup_bounds(values, bounds_name, param_name)

  values <- fix_missing_bounds(values, bounds_name)

  return(values)
}


#' Setting bounds values (min, max) for missing bounds and/or
#' naming bounds values vector with bounds names
#'
#' @param values Vector of bounds values (may be NULL or empty value)
#' @param bounds_name Character vector of bounds names (in "min", "max"
#' one of them or both)
#'
#' @return A named vector for bound(s)
#'
#' @keywords internal
#' @noRd
#'
#'
#'
fix_missing_bounds <- function(values, bounds_name) {
  # Fixing missing values
  val <- unlist(values)

  if (!base::is.null(val) && length(val) != 0) {
    values <- as.numeric(val)
  } else {
    values <- c(NA, NA)[seq_along(bounds_name)]
  }

  names(values) <- bounds_name

  return(values)
}


fix_dup_bounds <- function(values, bounds_name, param_name) {
  # Fixing duplicates
  values <- lapply(values, unique)
  duplicates <- unlist(lapply(values, function(x) length(x) > 1))

  if (!any(duplicates)) {
    return(values)
  }

  for (i in seq_along(duplicates)) {
    if (duplicates[i] && bounds_name[i] == "min") {
      values[[i]] <- min(values[[i]])
    }

    if (duplicates[i] && bounds_name[i] == "max") {
      values[[i]] <- max(values[[i]])
    }
  }

  if (any(duplicates)) {
    warning(paste(
      "Found different values in bound(s) \n",
      paste(bounds_name[duplicates], collapse = ", "),
      "\nfor parameter",
      param_name,
      "\nA single value has been selected.\n",
      paste(
        sprintf(
          "%s: %s",
          bounds_name[duplicates],
          as.character(values[duplicates])
        ),
        collapse = "\n"
      )
    ))
  }

  return(values)
}