R/load-fgs.R

In atlantistools: Process and Visualise Output from Atlantis Models

#' Load the functional group file
#'
#' Read in the functional group file as dataframe.
#'
#' @param fgs Character string giving the connection to the functional groups file.
#' The filename usually contains \code{Groups} and does end in \code{.csv}.
#'
#' @export
#' @family load functions
#'
#' @return A \code{data.frame} of functional group information.
#'
#' @examples
#' d <- system.file("extdata", "setas-model-new-becdev", package = "atlantistools")
#' file <- "SETasGroups.csv"
#' fgs <- load_fgs(file.path(d, file))
#' head(fgs)
#'
#' d <- system.file("extdata", "setas-model-new-trunk", package = "atlantistools")
#' file <- "SETasGroupsDem_NoCep.csv"
#' fgs <- load_fgs(file.path(d, file))
#' head(fgs)

load_fgs <- function(fgs) {
  result <- utils::read.table(file = fgs, sep = ",", header = TRUE, stringsAsFactors = FALSE)
  # Rename column longname if space is present in raw file.
  names(result)[names(result) == "Long.Name"] <- "LongName"
  return(result)
}