R/get-representatives.R

In tobiasziegler/openaustralia: OpenAustralia API Bindings for R

#' Fetch a list of members of the House of Representatives
#'
#' @param tidy Convert the output list to a tidyverse-ready format
#' @param postcode Fetch the list of Representatives whose electoral division
#'   lies within the postcode (there may be more than one)
#' @param date Fetch the list of members of the House of Representatives as it
#'   was on this date
#' @param party Fetch the list of Representatives from the given party
#' @param search Fetch the list of Representatives that match this search string
#'   in their name
#'
#' @export
get_representatives <- function(tidy = TRUE, postcode = NULL, date = NULL,
                                party = NULL, search = NULL) {
  getRepresentatives(tidy, postcode, date, party, search)
}

#' @rdname get_representatives
getRepresentatives <- function(tidy = TRUE, postcode = NULL, date = NULL,
                               party = NULL, search = NULL) {
  params <- params_from_call(match.call())
  response <- do.call("call_api", params)

  if (!tidy)
    return(response)

  tidy_members(response)
}