R/statcan_search.R

In statcanR: Client for Statistics Canada's Open Economic Data

#' Searching function for statcanR
#'
#'
#' Easily connect to Statistics Canada's Web Data Service with R. Open economic data (formerly known as CANSIM tables, now identified by Product IDs (PID)) are accessible as a data frame, directly in the user's R environment.
#'
#'
#' @description The \code{statcan_search()} function has 2 arguments to fulfill to find a database: {keywords} and {lang}.
#' The keywords argument refers to words that can be found in either the title or the description of the database. For example, inserting the keywords
#' "economy","export",and "link" will bring up the title, table id, description, and release date for databases that include these keywords. In this case, only one data table ("Supply and use tables, link-1997 level")
#' would be returned as it is the only data table containing all three words.
#'
#'
#' @param keywords The words that appear in the title or description of the data table
#' @param lang The language wanted
#'
#' @return The output will be the title, id, description, and release date of a table
#' @export
#'
#' 
#' @import DT
#' @import curl
#' @import qpdf
#' @import qs
#' @import dplyr
#' @import ggplot2
#' @import reshape2

#' @examples statcan_search(c("economy","export","link"),"eng")


statcan_search <- function(keywords,lang) {
  
  # Get the whole list of available tables from statCan into a temp forlder
  url <- paste0("https://warin.ca/datalake/statcanR/statcan_data.qs")
  
  if (httr::http_error(url)) 
  { # network is down = message (not an error anymore)
    message("No tables with this combination of keywords")
  } else{ 
    path <- file.path(tempdir(), "temp.qs")
    curl::curl_download(url, path)
    qs_file <- file.path(paste0(tempdir(), "/temp.qs"))
    statcandata <- qs::qread(qs_file)
    
  }
  
  # Loading data
  if (lang == "eng") {
    
      # Creating the keyword matches
      keyword_regex <- paste0("(", paste(keywords, collapse = "|"), ")", collapse = ".*")
      
      matches <- apply(statcandata, 1, function(row) {
        all(sapply(keywords, function(x) {
          grepl(x, paste(as.character(row), collapse = " "))
        }))
      })
      
      # Keep only obs with matched keywords and create datatable 
      filtered_data <- statcandata[matches, ]
      return(datatable(filtered_data,options = list(pageLength = 5)))  
  }
  
  if (lang == "fra") {
      
      # Creating the keyword matches
      keyword_regex <- paste0("(", paste(keywords, collapse = "|"), ")", collapse = ".*")
      
      matches <- apply(statcandata, 1, function(row) {
        all(sapply(keywords, function(x) {
          grepl(x, paste(as.character(row), collapse = " "))
        }))
      })
      
      
      # Keep only obs with matched keywords and create datatable 
      filtered_data <- statcandata[matches, ]
      return(datatable(filtered_data,options = list(pageLength = 5)))  
  }
}