R/link_poi_naics.R

In SafeGraphInc/SafeGraphR: Package for Processing and Analyzing SafeGraph Data

#' Use a Core Places file to Create a POI-NAICS crosswalk
#'
#' Feed this function the most recent Core Places file, and it will give you back a \code{data.table} with two columns: \code{safegraph_place_id} and \code{naics_code}. Saving this file is recommended. Then, provide this object to \code{read_shop} or \code{read_many_shop} so that you can use \code{'naics_code'} in the \code{by} argument.
#'
#' This function is DEPRECATED. It only works with the OLD Core files (and thus the continued usage of \code{safegraph_place_id} instead of \code{placekey}), and is superseded by the more flexible \code{read_core()} function.
#'
#' @param filename The filename of the \code{ZIP} Core Places file.
#' @param dir The directory that the file is in.
#' @param exdir Name of the directory to unzip to.
#' @param cleanup Set to \code{TRUE} to delete all the unzipped files after being read in.
#' @param silent Suppress timing messages.
#' @examples
#'
#' \dontrun{
#' # Core-USA-June2020-Release-CORE_POI-2020_05-2020-06-06.zip is a Core places file in the working directory
#' poi_link <- link_poi_naics('Core-USA-June2020-Release-CORE_POI-2020_05-2020-06-06.zip')
#' }
#' @export

link_poi_naics <- function(filename, dir = '.', exdir = dir, cleanup = FALSE, silent = FALSE) {

  # Where's our zip?
  if (!(stringr::str_sub(dir,nchar(dir)) == '/')) {
    dir <- paste0(dir,'/')
  }
  if (stringr::str_sub(exdir,nchar(exdir)) == '/') {
    exdir <- stringr::str_sub(exdir, 1, nchar(exdir)-1)
  }

  f <- paste0(dir,filename)

  # Get the list of files
  files_in_zip <- utils::unzip(f,list=TRUE)$Name
  # Only the .csv.gzs count
  files_in_zip <- files_in_zip[grep('\\.csv\\.gz',files_in_zip)]
  # And unzip
  utils::unzip(f, files = files_in_zip, exdir = exdir)

  files_in_zip %>%
    paste0(dir,.) %>%
    purrr::map(function(x) {
      if (!silent) {
        message(paste('Starting to read',x,'at',Sys.time()))
      }
      patterns <- data.table::fread(x, select = c('safegraph_place_id',
                                      'naics_code'))
      patterns <- patterns[!is.na(naics_code)]
      if (cleanup) {
        file.remove(x)
      }
      return(patterns)
    }) %>%
    data.table::rbindlist() %>%
    unique() %>%
    return()

}