R/n2k_model_class.R

In INBO-Natura2000/n2kanalysis: Generic Functions to Analyse Data from the 'Natura 2000' Monitoring

#' The `n2kModel` class
#'
#' A virtual superclass to contain the analysis models
#' @name n2kModel-class
#' @rdname n2kModel-class
#' @exportClass n2kModel
#' @aliases n2kModel-class
#' @importFrom methods setClass
#' @docType class
#' @include n2k_analysis_metadata_class.R
setClass(
  "n2kModel",
  representation = representation(
    "VIRTUAL"
  ),
  contains = "n2kAnalysisMetadata"
)

#' @importFrom methods setValidity
setValidity(
  "n2kModel",
  function(object) {
    if (nrow(object@AnalysisMetadata) != 1) {
      stop("The 'AnalysisMetadata' slot must contain exactly one row")
    }
    if (nrow(object@AnalysisRelation) > 0) {
      if (any(
        object@AnalysisRelation$analysis !=
          object@AnalysisMetadata$file_fingerprint
      )) {
        stop(
        "Some Analysis in 'AnalysisRelation' slot don't match file_fingerprint"
        )
      }
    }
    return(TRUE)
  }
)