R/utils.R

In odbr: Download Data from Brazil's Origin Destination Surveys

# Compose the base name of map files -------------------------------
compose_file_path <- function(city, year, harmonize) {
  city_text <- clean_string(city)

  harmonized_text <- "not_harmonized"
  if (harmonize == TRUE) {
    harmonized_text <- "harmonized"
  }
  filepath <- paste0("data-raw/", city_text, "/", year, "/", harmonized_text)

  return(filepath)
}

# Compose the base name of data / dictionary / map files -----------
compose_name <- function(city, year, harmonize, level = "od") {
  city_text <- clean_string(city)

  harmonized_text <- "not_harmonized"
  if (harmonize == TRUE) {
    harmonized_text <- "harmonized"
  }

  level_text <- clean_string(level)

  name <- paste0(level_text, "_", city_text, "_", year, "_", harmonized_text)
  return(name)
}

# Convert sav to csv.gz file, and upload to repository -------------
upload_sav_db_to_repo <- function(city, year, harmonize, repository, tag) {
  base_filename <- paste0(
    compose_file_path(city, year, harmonize), "/",
    compose_name(city, year, harmonize)
  )

  # Creating the filename to download
  filename_to_download <- paste0(base_filename, ".sav")

  # Reading raw data
  od <- haven::read_sav(filename_to_download)

  # Creating compacted filename
  compacted_filename <- paste0(base_filename, ".csv.gz")

  # Compacting the file (.gz)
  data.table::fwrite(od,
    file = compacted_filename,
    sep = ";"
  )

  # Uploading a file to a specific release from odbr repo (see parameter)
  piggyback::pb_upload(
    file = compacted_filename,
    repo = repository,
    tag = tag
  )
}

# Remove non-ASCII characters -------------------------------------
clean_string <- function(text) {
  gsub("~", "", gsub(" ", "_", tolower(iconv(text, to = "ASCII//TRANSLIT"))))
}

# Dummy flag just to make one explicit usage of R.utils (dependency) to
# please R CMD check test and avoid it complaining that R.utils is listed in the
# Imports section of DESCRIPTION but it is not being used anywhere.
# R.utils is a "cross dependency" from piggyback.
# Got this trick from:
# https://community.rstudio.com/t/new-r-cmd-check-note-in-r-4-2-0-for-imports-field/143153/2
.dummy <- function() {
  R.utils::check.Assert
}