pull_bitre_data: Pull BITRE data

In mattsq/examplePackage: Me playing with usethis and devtools

Description

Uses the CKAN data.gov.au API to pull records - tuned for the BITRE API.

Usage

pull_bitre_data(
  base_url,
  resource_id,
  limit = 5000,
  offset = 1,
 
    sort = "Year desc, Month_Num desc, Airline desc, Departing_Port asc, Arriving_Port asc",
  records_format = "objects"
)

Arguments

base_url	The base data.gov.au API URL
resource_id	The specific resource ID code from the data.gov.au website
limit	The number of rows you want to pull
offset	the rownumber start
sort	a text string, in SQL style, indicating how you'd like to sort the records
records_format	leave this as objects for the moment

Details

Retrieves a dataframe, with some limited filtering capabilities

Value

This function will return a data frame of the BITRE on time performance data.

Author(s)

Matt Simmons [e-mail]

Examples

## Not run: 
data <- pull_bitre_data <- function(base_url = url, resource_id = id)

## End(Not run)

mattsq/examplePackage documentation built on May 23, 2020, 12:23 p.m.