R/map_experiment.R

In r-and-gama/rama: An R Interface to the GAMA Simulation Platform

#' Map a data frame on an experiment
#'
#' Maps the data of a data frame on the structure on an object of class
#' \code{experiment}.
#'
#' The names of the columns of the data frame should correspond to the names of
#' the variables and parameters of the experiment. This can work only if one of
#' the following conditions is met:
#' \itemize{
#'   \item the sets of names of the data frame and experiment are identical;
#'   \item the names of the data frame are included in the names of the
#'         experiment AND the numbers of rows of the data frame and the
#'         experiment are identical.
#' }
#'
#' @param df A data frame containing variables and parameters values for a
#'           number of simulations we wish to use for the experiment \code{exp}.
#' @param exp An object of class \code{experiment}. See \code{Details} for
#'            constraints on this object.
#'
#' @export
#'
#' @example inst/examples/map_experiment.R
map_experiment <- function(df, exp) {
  stopifnot(is.data.frame(df))

  # Type casting for numeric values, character not passed
  obsrates <- names(df)[grepl("r_", names(df))]
  if (!all(sapply(df[, obsrates], is.numeric))) {
    message(cat(
      "Periods of observation (\"obsrates\") are converted into integers"))
    df[, obsrates] <- lapply(df[, obsrates], function(x) as.integer(x))
  }

  if (all(!is.null(df$tmax),
          is.numeric(df$tmax))) {
    message(cat(
      "Final time step (\"tmax\") is converted into integer."))
    df$tmax <- as.integer(df$tmax)
  }

  # seed can't be double in gama?, to be confirmed
  if (all(!is.null(df$seed),
           is.numeric(df$seed))) {
    message(cat(
      "Seed is converted into integer."))
    df$seed <- as.integer(df$seed)
  }

  if (setequal(names(df), names(exp))) {
    the_attributes <- attributes(exp)
    the_attributes$row.names <- row.names(df)
    attributes(df) <- the_attributes
    return(validate_experiment(df))
  }

  if (all(names(df) %in% names(exp), nrow(df) == nrow(exp))) {
      exp[, names(df)] <- df
      return(validate_experiment(exp))
  }
    stop(paste0("A data frame 'df' can be mapped on an experiment 'exp' only\n",
                "if one of the following conditions is met:\n",
                "  - the sets of names of 'df' and 'exp' are identical;\n",
                "  - the names of 'df' are included in the names of 'exp'",
                " AND the numbers of rows of 'df' and 'exp' are identical."))
}