R/get_open_data.R

In jdallmann/winnipegr: winnipeg open data aggregator

#' City of Winnipeg Open Data API
#'
#' This function uses the \code{RSocrata} package to get Winnipeg
#' City data from the Winnipeg Open Data site \code{data.winnipeg.ca}.
#' Users with a City of Winnipeg open data account can also use their
#' login credentials to have full (non-throttled) access to the API.
#'
#' @import RSocrata
#'
#' @export
#'
#' @param type Specifies with data set to download. Currently supports
#'     WPA parking station data (\code{"parking"}), 2018 election
#'     polling subdivision units (\code{"2018 polling geoms"}), air
#'     quality data (\code{"air quality"}), taxation assessment parcels
#'     (\code{"tax parcels"}), tree inventory (\code{"trees"}), building
#'     permits (\code{"building permits"}), snow plow schedule
#'     (\code{"plow schedule"}), parking ban schedule (\code{"parking bans"}),
#'     parks and open space (\code{"parks"}), park asset inventory
#'     (\code{"park assets"}), council member expenses
#'     (\code{"council expenses"}), (\code{"public notices"}), daily adult
#'     mosquito trap data (\code{"mosquito traps"}), (\code{"address coords"}),
#'     detailed building permit data (\code{"permit details"}), burial records
#'     (\code{"burials"}), public meeting dispositions (\code{"dispositions"}),
#'     311 service requests (\code{"311"}), lane closure
#'     (\code{"lane closures"}), by-law investigations (\code{"by-law"}),
#'     recycling, garbage and yard waste collection days
#'     (\code{"collection days"}), 311 interactions by channel
#'     (\code{"311 channels"}), (\code{"school enrolments"}),
#'     (\code{"river levels"}), residential garbage, recycling and yard waste
#'     tonnage reports (\code{"waste tonnage"}), Winnipeg City open data
#'     and website analytics (\code{"web analytics"}), James Avenue river
#'     levels (\code{"river james"}),
#'     \code{"vehicle for hire contravention"}, \code{"parking citations"},
#'     \code{"ticket adjudication results"}, \code{"TSI-cameras detail"},
#'     \code{"TSI-pole and cabinet locations"}, \code{"TSI-locations"},
#'     \code{"TSI-corridor box indications detail"},
#'     \code{"TSI-corridor boxes detail"},
#'     \code{"TSI-heads (displays) detail"}, \code{"TSI-hardware detail"},
#'     \code{"TSI-pole and arms detail"}, \code{"TSI-bases detail trans"},
#'     \code{"TSI-pole and arms detail"}, \code{"traffic signal malfunctions"},
#'     \code{"TSI-traffic signal damage"}, \code{"transport mode"},
#'     \code{"TMC-confirmed incidents"}, \code{"transit on-time"},
#'     \code{"transit on-time hist"}, \code{"transit pass-ups"},
#'     \code{"fipa requests"}, \code{"capex"}, \code{"survey parcel"},
#'     \code{"boundary"}, \code{"population"}.
#'
#' @param app_token Optional app_token parameter for users with a city
#'     of Winnipeg Open Data account available at
#'     (https://data.winnipeg.ca/)
#' @param email Optional email parameter for users with a city
#'     of Winnipeg Open Data account available at
#'     (https://data.winnipeg.ca/)
#' @param password Optional password parameter for users with a city
#'     of Winnipeg Open Data account available at
#'     (https://data.winnipeg.ca/)
#'
#' @return A dataframe containing the relvant data set.
#'
#' @examples
#' \dontrun{
#'     get_open_data("trees")
#'
#'     get_open_data("parking", app_token = SOME_API_TOKEN,
#'         email = FAKE_EMAIL,
#'         password = FAKE_PASSWORD)
#'
#'     get_open_data(search_open_data("clerk")$identifier[1])
#' }
#'
get_open_data <- function(type = c("parking", "2018 polling geoms",
                                   "air quality", "tax parcels",
                                   "trees", "building permits",
                                   "plow schedule", "parking bans",
                                   "parks", "park assets",
                                   "council expenses", "public notices",
                                   "mosquito traps", "address coords",
                                   "permit details", "burials",
                                   "dispositions", "311",
                                   "lane closures", "contravention",
                                   "vehicle for hire contravention",
                                   "parking citations", "ticket adjudication results",
                                   "TSI-cameras detail",
                                   "TSI-pole and cabinet locations", "TSI-locations",
                                   "TSI-corridor box indications detail",
                                   "TSI-corridor boxes detail",
                                   "TSI-heads (displays) detail", "TSI-hardware detail",
                                   "TSI-pole and arms detail", "TSI-bases detail trans",
                                   "TSI-pole and arms detail",
                                   "traffic signal malfunctions",
                                   "TSI-traffic signal damage", "transport mode",
                                   "TMC-confirmed incidents",
                                   "transit on-time", "transit on-time hist",
                                   "transit pass-ups", "fipa requests",
                                   "capex", "river levels",
                                   "river james", "survey parcel",
                                   "boundary", "population"),
                          app_token = NA,
                          email = NA,
                          password  = NA){
    # type <- match.arg(type)
    # library(RSocrata)
    if(!requireNamespace("RSocrata", quietly = TRUE)){
        stop("The 'RSocrata' package needs to be installed first")
    }

    if(type == "parking"){
        datasetID <- "c2m5-vayh"
    } else if(type == "2018 polling geoms"){
        datasetID <- "7cfr-9tgh"
    } else if(type == "air quality"){
        datasetID <- "f5p2-7r36"
    } else if(type == "tax parcels"){
        datasetID <- "94a6-v8ue"
    } else if(type == "trees"){
        datasetID <- "d3jk-hb6j"
    } else if(type == "building permits"){
        datasetID <- "m4wt-mqkb"
    } else if(type == "plow schedule"){
        datasetID <- "mfzv-893p"
    } else if(type == "parking bans"){
        datasetID <- "tix9-r5tc"
    } else if(type == "parks"){
        datasetID <- "tug6-p73s"
    } else if(type == "park assets"){
        datasetID <- "9qbp-pngj"
    } else if(type == "council expenses"){
        datasetID <- "mgde-4fua"
    } else if(type == "public notices"){
        datasetID <- "gnxp-9hpt"
    } else if(type == "mosquito traps"){
        datasetID <- "du7c-8488"
    } else if(type == "address coords"){
        datasetID <- "w4xz-nc35"
    } else if(type == "permit details"){
        datasetID <- "5uac-hgtk"
    } else if(type == "burials"){
        datasetID <- "iibp-28fx"
    } else if(type == "dispositions"){
        datasetID <- "qevm-pxyq"
    } else if(type == "311"){
        datasetID <- "9w2n-uhf9"
    } else if (type == "by-law"){
        datasetID <- "eye3-guud"
    } else if (type == "collection days"){
        datasetID <- "6rcy-9uik"
    } else if (type == "311 channels"){
        datasetID <- "485c-dk3k"
    } else if (type == "school enrolments"){
        datasetID <- "ukha-ify8"
    } else if (type == "river levels"){
        datasetID <- "tgrf-v2zc"
    } else if (type == "waste tonnage"){
        datasetID <- "fgza-8s5e"
    } else if (type == "river James"){
        datasetID <- "q8w3-jhjb"
    } else if (type == "vehicle for hire contravention"){
        datasetID <- "rzfe-3um4"
    } else if (type == "parking citations"){
        datasetID <- "bhrt-29rb"
    } else if (type == "ticket adjudication results"){
        datasetID <- "hzdi-nwqn"
    } else if (type == "TSI-cameras detail"){
        datasetID <- "42pk-2u2c"
    } else if (type == "TSI-pole and cabinet locations"){
        datasetID <- "57s9-d44a"
    } else if (type == "TSI-locations"){
        datasetID <- "utdw-xwym"
    } else if (type == "TSI-corridor box indications detail"){
        datasetID <- "bu5e-xfzz"
    } else if (type == "TSI-corridor boxes detail"){
        datasetID <- "t4v5-7aux"
    } else if (type == "TSI-heads (displays) detail"){
        datasetID <- "3jzf-z9w2"
    } else if (type == "TSI-hardware detail"){
        datasetID <- "5kuj-ijzu"
    } else if (type == "TSI-pole and arms detail"){
        datasetID <- "rnjd-2kp8"
    } else if (type == "TSI-bases detail trans"){
        datasetID <- "ygik-qdgr"
    } else if (type == "TSI-pole and arms detail"){
        datasetID <- "rzfe-3um4"
    } else if (type == "traffic signal malfunctions"){
        datasetID <- "er6v-aifz"
    } else if (type == "TSI-traffic signal damage"){
        datasetID <- "rfk8-6wx8"
    } else if (type == "transport mode"){
        datasetID <- "ijxa-tybv"
    } else if (type == "TMC-confirmed incidents"){
        datasetID <- "4c3j-pczr"
    } else if (type == "transit on-time"){
        datasetID <- "gp3k-am4u"
    } else if (type == "transit pass-ups"){
        datasetID <- "mer2-irmb"
    } else if (type == "transit on-time hist"){
        datasetID <- "cymk-nyei"
    }else if (type == "fipa requests"){
        datasetID <- "pfbi-rm6v"
    } else if (type == "capex"){
        datasetID <- "8xrn-n992"
    } else if (type == "survey parcel"){
        datasetID <- "emk4-cdaw"
    } else if (type == "boundary"){
        datasetID <- "jx93-sett"
    } else if (type == "population"){
        datasetID <- "mhuw-u7yg"
    } else{
        datasetID <- type
    }


    jsonID <- paste0("https://data.winnipeg.ca/resource/",
                     datasetID,
                     ".json")
    if(is.na(app_token)){
        read.socrata(jsonID)
    } else {
        read.socrata(jsonID,
                     app_token = app_token,
                     email = email,
                     password = password)
    }

}