R/model.R

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

# model ------------------------------------------------------------------------
#' Get/Set the model of an experiment
#'
#' These functions allow to get and set the path to the \code{.gaml} file that
#' contains the model of an \code{experiment} object.
#'
#' @param exp An object of class \code{experiment}.
#'
#' @return The path to the \code{.gaml} file that contains the model definition.
#'
#' @example inst/examples/model.R
#' @export
#'
model <- function(exp) UseMethod("model")

#' @rdname model
#' @export
model.default <- function(exp) "Unknown class"

#' @rdname model
#' @export
model.experiment <- function(exp) attributes(exp)$model

# set_model---------------------------------------------------------------------
#' This function allows to change the model path of an experiment object
#'
#' @param value Path of new gaml model file
#' @importFrom tools md5sum
#'
#' @rdname model
#' @example inst/examples/model.R
#' @export
`model<-` <- function(exp, value) UseMethod("model<-")

#' @rdname model
#' @export
`model<-.default` <- function(exp, value) "Unknown class"

#' @rdname model
#' @importFrom utils capture.output
#' @export
`model<-.experiment` <- function(exp, value){
  model_info <- list("path" = value,
                     "info" = read_gaml_experiment(name(exp), value),
                     "md5sum" = md5sum(value))
  attr(exp, "model") <- model_info
  return(validate_experiment(exp))
}