R/meta.groundhog.R

#' Load a specific version of groundhog, as available on a given date 
#' 
#'@param date character string  (yyyy-mm-dd), or date value, with the date which determines the 
#'version of groundhog to load 
#'@examples
#' \dontrun{
#' #Load groundhog as available on 2021-03-12 (v1.3.2)
#' meta.groundhog("2021-03-12")
#' }
#' 
#' @export


  meta.groundhog <- function (date)
      {
      #0 The package is groundhog
         pkg='groundhog'
  
      #1) Is date valid?
         validate.date(date) #Function defined in utils.R

      #2) Make a snowball, which is really just groundhog
          snowball <- get.snowball(pkg, date)

          
          
      #3) Unload the pkg
          unloadNamespace('groundhog')
        
    
      #4) Install it (always from source)
          if (snowball[1,]$installed==FALSE) {
             ap_source <- get.current.packages("source")
             repos <- as.character(getOption("repos"))
             snowball$source_url <- ifelse(snowball$pkg_vrs %in% ap_source$pkg_vrs, 
                      paste0(repos , "/src/contrib/" ,snowball$pkg_vrs , ".tar.gz"),
                      paste0(repos , "/src/contrib/Archive/" ,snowball$pkg , "/" ,  snowball$pkg_vrs , ".tar.gz"))
             
             
            dir.create(snowball$installation.path,recursive = TRUE,showWarnings = TRUE)
            utils::install.packages(snowball$source_url,repos=NULL, type='source', lib=snowball$installation.path)
          }
          
          
      #5) attach the requested version
         suppressPackageStartupMessages ( loadNamespace('groundhog', lib.loc = snowball$installation.path[1]))
         suppressPackageStartupMessages ( attachNamespace('groundhog'))
         
      #6) message
         vrs <- get.version('groundhog',date)
         message2("Now using 'groundhog_" , vrs , "'.")
         
      #7) Warning if version is prior ot 1.4 that meta is no longer available
         if (compareVersion(vrs,"1.4.0") <0) {
           message1("This version of groundhog does not have the 'meta.groundhog()' function.")
           message1("To switch to a different version of groundhog, you will have to restart ")
           message1("the R session reload groundhog' \n ",restart.text())
           
         }

      }

Try the groundhog package in your browser

Any scripts or data that you put into this service are public.

groundhog documentation built on Sept. 29, 2024, 9:06 a.m.