R/get_analysis_version.R

In inbo/n2kanalysis: Generic Functions to Analyse Data from the 'Natura 2000' Monitoring

#' Get an analysis version
#' @param version the object to extract the version
#' @name get_analysis_version
#' @rdname get_analysis_version
#' @exportMethod get_analysis_version
#' @docType methods
#' @importFrom methods setGeneric
setGeneric(
  name = "get_analysis_version",
  def = function(version) {
    standardGeneric("get_analysis_version")
  }
)

#' @rdname get_analysis_version
#' @aliases get_analysis_version,sessionInfo-methods
#' @importFrom methods setMethod new
#' @importFrom n2khelper check_dataframe_variable
#' @include n2k_analysis_version_class.R
setMethod(
  f = "get_analysis_version",
  signature = signature(version = "data.frame"),
  definition = function(version) {
    check_dataframe_variable(
      df = version, name = "version",
      variable = c("description", "version", "origin", "fingerprint")
    )
    assert_that(
      !is.null(attr(version, "analysis_version")),
      msg = "Missing analysis_version attribute"
    )
    analysis_version <- data.frame(
      fingerprint = attr(version, "analysis_version"), stringsAsFactors = FALSE
    )
    version <- version[order(version$description, version$version), ]
    new(
      "n2kAnalysisVersion",
      AnalysisVersion = analysis_version, RPackage = version,
      AnalysisVersionRPackage = data.frame(
        analysis_version = analysis_version$fingerprint,
        r_package = version$fingerprint, stringsAsFactors = FALSE
      )
    )
  }
)

#' @rdname get_analysis_version
#' @aliases get_analysis_version,n2kAnalysisMetadata-methods
#' @importFrom methods setMethod new
#' @include n2k_analysis_metadata_class.R
setMethod(
  f = "get_analysis_version",
  signature = signature(version = "n2kAnalysisMetadata"),
  definition = function(version) {
    new(
      "n2kAnalysisVersion",
      AnalysisVersion = version@AnalysisVersion,
      Rpackage = version@Rpackage,
      AnalysisVersionRPackage = version@AnalysisVersionRPackage
    )
  }
)

#' @rdname get_analysis_version
#' @aliases get_analysis_version,sessionInfo-methods
#' @importFrom methods setMethod new
#' @importFrom utils sessionInfo
#' @include import_s3_classes.R
setMethod(
  f = "get_analysis_version",
  signature = signature(version = "sessionInfo"),
  definition = function(version) {
    get_analysis_version(version = session_package(version))
  }
)