R/get_internal_api.R

In dataquieR: Data Quality in Epidemiological Research

#' Get Access to Utility Functions
#'
#' `r if (suppressWarnings(util_ensure_suggested("lifecycle", err = FALSE))) { lifecycle::badge("experimental") }`
#' TODO: more life-cycle stuff, also for deprecation
#'
#' @param fkt function name
#' @param version version number to get
#'
#' @return an API object
#' @export
#'
#' @keywords internal
.get_internal_api <- function(fkt, version = API_VERSION) {
  util_stop_if_not(version == API_VERSION)
  f <- substitute(fkt)
  if (is.symbol(f)) {
    fkt <- as.character(f)
  }
  util_stop_if_not(is.character(fkt))
  util_stop_if_not(exists(fkt, mode = "function"))
  if (missing(version)) {
    util_warning(c("Hint: As a developer, you should not omit",
                   "the API version, when you access the internal API of %s,",
                   "write %s"),
                  sQuote(utils::packageName()),
                  sQuote(paste0(".get_internal_api(", fkt, ", version=\"",
                                API_VERSION, "\")"))
                 )
  }
  get(fkt, mode = "function")
}


#' Version of the API
#'
#' @seealso [.get_internal_api()]
#'
#' @export
#' @keywords internal
API_VERSION <- "0.0.1"