R/getBusRoutes.R

In shaunkhoo/ltaer: R Package for LTA's APIs

#' @title Bus Routes
#'
#' @description Returns information on all bus routes in Singapore that are currently in operation.
#'
#' @param api_key API key for LTA's Datamall
#' @return A dataframe containing all the outputs from the Bus Routes API, such as the operator, stop sequence, bus stop code, and distance travelled.
#' @examples
#' \donttest{
#' getBusRoutes(mykey)
#' }
#' @import httr
#' @import dplyr
#' @export getBusRoutes

getBusRoutes <- function(api_key) {
  result <- httr::GET("http://datamall2.mytransport.sg/ltaodataservice/BusRoutes",
                httr::add_headers(AccountKey = api_key)
                )
  if (httr::http_status(result)$category != "Success") {
    message("Unsuccessful API call for bus routes. Please check your parameters or connection.")
    return(NA)
  } else {
    message("Successful API call for all bus routes. Processing page 1...")
  }
  output <- data.frame(matrix(nrow = 0, ncol = 12))
  busroutes_list <- httr::content(result)[[2]]
  for (i in 1:length(busroutes_list)) {
    interim <- busroutes_list[[i]]
    interim[sapply(interim, is.null)] <- 0
    output <- rbind(output, t(unlist(interim)))
  }
  names(output) <- names(unlist(busroutes_list[[1]]))
  num <- 2
  while(length(busroutes_list) > 499) {
    result <- httr::GET(paste("http://datamall2.mytransport.sg/ltaodataservice/BusRoutes", "?$skip=", (num-1)*500, sep=""),
                  httr::add_headers(AccountKey = api_key)
    )
    if (httr::http_status(result)$category != "Success") {
      message("Unsuccessful API call for bus routes. Please check your parameters or connection.")
      return(NA)
    } else {
      message("Successful API call for all bus routes. Processing page ", num, "...")
    }
    output0 <- data.frame(matrix(nrow = 0, ncol = 12))
    busroutes_list <- httr::content(result)[[2]]
    for (i in 1:length(busroutes_list)) {
      interim <- busroutes_list[[i]]
      interim[sapply(interim, is.null)] <- 0
      output0 <- rbind(output0, t(unlist(interim)))
    }
    output <- rbind(output, output0)
    num <- num + 1
  }

  for (col in colnames(output)) {
    output[[col]] <- as.character(output[[col]])
  }

  message('API call complete. Number of bus routes returned: ', output %>% dplyr::distinct(output$ServiceNo) %>% nrow())
  return(output)
}