R/time_filter_postcode_districts.R

In traveltimeR: Interface to 'Travel Time' API

#' Time Filter (Postcode Districts)
#'
#'Find districts that have a certain coverage from origin (or to destination) and get statistics about postcodes within such districts.
#'Currently only supports United Kingdom.
#'
#' See \url{https://docs.traveltime.com/api/reference/postcode-district-filter/} for details
#'
#' @inheritParams time_filter
#'
#' @return API response parsed as a list and as a raw json
#' @export
#'
#' @examples \dontrun{
#' departure_search <-
#'   make_search(id = "public transport from Trafalgar Square",
#'               departure_time = strftime(as.POSIXlt(Sys.time(), "UTC"), "%Y-%m-%dT%H:%M:%SZ"),
#'               travel_time = 1800,
#'               coords = list(lat = 51.507609, lng = -0.128315),
#'               transportation = list(type = "public_transport"),
#'               reachable_postcodes_threshold = 0.1,
#'               properties = list("coverage", "travel_time_reachable", "travel_time_all"))
#'
#' arrival_search <-
#'   make_search(id = "public transport to Trafalgar Square",
#'               arrival_time = strftime(as.POSIXlt(Sys.time(), "UTC"), "%Y-%m-%dT%H:%M:%SZ"),
#'               travel_time = 1800,
#'               coords = list(lat = 51.507609, lng = -0.128315),
#'               transportation = list(type = "public_transport"),
#'               reachable_postcodes_threshold = 0.1,
#'               properties = list("coverage", "travel_time_reachable", "travel_time_all"))
#'
#' result <-
#'   time_filter_postcode_districts(
#'     departure_searches = departure_search,
#'     arrival_searches = arrival_search
#'   )
#'}
time_filter_postcode_districts <- function(departure_searches = NULL, arrival_searches = NULL) {

  if((is.null(departure_searches) && is.null(arrival_searches))) {
    stop("At least one of arrival_searches/departure_searches required!")
  }

  body <- list(
    departure_searches = departure_searches,
    arrival_searches = arrival_searches)

  traveltime_api(path = c('time-filter', 'postcode-districts'), body = build_body(body))
}