R/helpers.R

Defines functions regdata_json_requestURL regdata_json_request get_baseURL clean_column_names

Documented in clean_column_names get_baseURL regdata_json_request regdata_json_requestURL

# HELPER FUNCTIONS
#' Given a flattened json file, produce R friendly column names.
#'
#' @param json - JSON file
#'
#' @return data frame
#'

clean_column_names <- function(data_frame){
  if(is.data.frame(data_frame)){

  }
}

## Get base url
get_baseURL <- function() {
    return("https://api.quantgov.org")
}

## Generate API call from controller and requested ID
regdata_json_request <- function(controller, id) {
    base_url <- get_baseURL()

    if (!is.na(id)) {
        apicall <- paste0(base_url, "/", controller, "/", id)
        print(apicall)
    } else {
        apicall <- paste0(base_url, "/", controller)
        print(apicall)
    }
    json <- jsonlite::fromJSON(apicall) #8/26/2019, Kofi: added full path to fromJSON
    return(json)
}

## Return URL of API call
regdata_json_requestURL <- function(controller, id) {
    base_url <- get_baseURL()

    if (!is.na(id)) {
        apicall <- paste0(base_url, "/", controller, "/", id)
    } else {
        apicall <- paste0(base_url, "/", controller)
    }

    return(apicall)
}
QuantGov/regcensus-api-client-R documentation built on Jan. 4, 2022, 12:02 a.m.