R/check_internal_cache.R

In AtlasOfLivingAustralia/galah: Biodiversity Data from the GBIF Node Network

#' Internal function to store objects generated from some `request_metadata` calls
#' 
#' This increases speed by ensuring that the atlas is only queried when needed.
#' When run with no arguments, it returns a list with currently stored objects.
#' When a named field is given, it stores that field in options("galah_internal")
#' @noRd
#' @keywords Internal
#' @importFrom potions pour
check_internal_cache <- function(...){

  # set all options
  ala_option_name <- "check_internal_cache"
  current_options <- getOption(ala_option_name)
  atlas <- pour("atlas", "region")
  user_options <- list(...)
  
  # load an archived version as the default
  default_options <- galah_internal_cached # stored in R/sysdata.rda
  # get0("galah_internal_cached", envir = asNamespace("galah")) # alternate code
    
  # deal with different kinds of query
  if (length(user_options) == 0 && !is.null(current_options)) {
    return(current_options)
  }
  if (is.null(current_options)) {
    ## galah options have not been set yet, so set them to the defaults
    current_options <- default_options
    ## set the global option
    temp <- list(current_options)
    names(temp) <- ala_option_name
    options(temp)
    return(current_options)
  } else {
    # check all the options are valid, if so, set as options
    for (x in names(user_options)) {
      current_options[[x]] <- user_options[[x]]
    }
    ## set the global option
    temp <- list(current_options)
    names(temp) <- ala_option_name
  }
  options(temp)
}

#' Internal function to decide whether to update the internal cache
#' @noRd
#' @keywords Internal
internal_cache_update_needed <- function(function_name){
  df <- check_internal_cache()[[function_name]]
  is_local <- !is.null(attr(df, "ARCHIVED"))
  is_wrong_atlas <- attr(df, "region") != pour("atlas", "region")
  is_too_short <- nrow(df) < 10
  result <- is_local | is_wrong_atlas | is_too_short # if any, update is needed
  if(length(result) < 1){result <- TRUE} # bug catcher
  result
}