R/glacie.R

In JDOsborne1/glacieR-vc: Keep Up To Date With Data Snapshots

#' Find Files
#'  Finding the files in the directory which match the filename
#'
#' @param filename The name of the file you are searching for in the path
#' @param directory The path you are searching for the file in
#'
#' @return gives a vector of strings with the filenames in
#' @export
#'
#' @examples
find_files <- function(filename, path){
  require(dplyr)
  return(list.files(path, pattern = filename))
}

#' Get Max
#'   Get the most recent date of the date stamps used in the files
#'
#' @param files A vector of filenames with date stamps in the YYYY-MM-DD format
#'
#' @return The Maximum date out of all those date stamps
#' @export
#'
#' @examples
get_max <- function(files){
  require(dplyr)
  require(stringr)
  out <- files %>%
    str_match("\\d{4}-\\d{2}-\\d{2}") %>%
    as.Date() %>%
    max()
  return(out)
}

#' Latest File
#'   Function to get the filename of the most recent file
#'
#' @param files A set of filenames
#'
#' @return The full filename of the most recent file in that set
#' @export
#'
#' @examples
latest_file <- function(files){
  require(dplyr)
  out <- files %>%
    get_max() %>%
    grep(files, value = T)
  return(out)
}

#' Get Face Function
#'   gets the full  path of the face of the glacier, the most recent snapshot of the data
#'
#' @param filename The file you are searching for
#' @param path the location where the files are versioned
#' @param legacy_time How many days ago is a file still considered modern
#'
#' @return The full path of the most recent version of the file, can be used in a reader function
#' @export
#'
#' @examples
get_face <- function(filename, path = getwd(), legacy_time = 10){
  require(lubridate)
  require(dplyr)
  files <- list.files(path, pattern = filename)
  #if(files %>% get_max() + days(legacy_time) < Sys.Date()) print(paste0("File is more than ",legacy_time, " out of date, consider rerunning the data prep"))
  #out <- file.path(path, files %>% latest_file())
  out <- paste0(path, files %>% latest_file())

  return(out)
}

#' Refresh Sheet Function
#'   Gets the most recent format of an object, if that object follows glacier
#'   naming conventions
#'
#' @param varname
#' @param path
#' @param flat_type
#'
#' @return
#' @export
#'
#' @examples
refresh_sheet <- function(varname, path = getwd(), flat_type = ".csv"){
  if(flat_type == ".csv"){
    filename <- paste0(deparse(substitute(varname)), ".csv")
    face <- filename %>%
      get_face(path)
    out <- read.csv(face, header = F)
  } else {
    print("No read define for that type")
  }
  return(out)
}