R/write_cell_param.R

In TroublemakeR: Generates Spatial Problems in R for 'AMPL'

#' @title Write cell parameters
#'
#' @description
#' This function takes a Raster object, uses its values as a parameter and writes them to a .dat file. The file
#' will be written to the location specified by the `name` argument. If the file
#' already exists, it will be overwritten. The file format is plain text, with each
#' line terminated by a newline character.
#'
#' @param Rasterparam A Raster object with the values for the parameter
#' @param parameter The name of the parameter to use
#' @param default The value of the default value for the parameter if
#' there is one, otherwise keep it as NULL
#' @param name The name of the output file
#' @param verbose Logical whether messages will be written while the
#' function is generating calculations, defaults to FALSE
#' @importFrom terra as.data.frame
#'
#' @return .dat file. This function is used for the side-effect of writing values to a file.
#'
#' @export
#'
#' @examples
#'
#' library(terra)
#'
#' A <- TroublemakeR::Current |> terra::unwrap()
#' A <- A[[1]]
#'
#' write_cell_param(Rasterparam = A, parameter = "Suitability", name = "Problem")
#'
#'  write_cell_param(Rasterparam = A, parameter = "Carbon", default = 1,
#'  name = "Problem")
#'
#'  write_cell_param(Rasterparam = A, parameter = "Cost", default = 0,
#'  name = "Problem")
#'
#'  file.remove("Problem.dat")


write_cell_param <- function(Rasterparam,
                         parameter,
                         default = NULL,
                         name = "Problem",
                         verbose = FALSE){
  Temp <- terra::as.data.frame(Rasterparam, cells = T)
  colnames(Temp)[2] <- "Param"

  if(file.exists(paste0(name, ".dat"))){
    sink(paste0(name, ".dat"), append = T)
    if(is.null(default)){
      cat(paste(c("param", parameter ,":= \n")))
    }
    if(!is.null(default)){
      cat(paste(c("param", parameter, "default", default ,":= \n")))
    }
    cat(paste_params(df = Temp, default = default))
    cat("; \n")
    sink()
  }

  if(!file.exists(paste0(name, ".dat"))){
    sink(paste0(name, ".dat"), append = T)
    if(is.null(default)){
      cat(paste(c("param", parameter ,":= \n")))
    }
    if(!is.null(default)){
      cat(paste(c("param", parameter, "default", default ,":= \n")))
    }
    cat(paste_params(df = Temp, default = default))
    cat("; \n")
    sink()
  }
}


paste_params <- function(df, default){
  if(!is.null(default)){
    df <- df[df[["Param"]] != default, ]
  }
  paste0(paste0("["), paste0(df$cell, "]", " ", as.vector(df["Param"][,1])))
}