outlets: Information for a all outlets

Description Usage Arguments Details Value Examples

View source: R/outlets.R

Description

Information for a all outlets

Usage

1
outlets(user_id = determine_user_id(), api_key = determine_api_key())

Arguments

user_id

Integer or character. A user ID or devid provided by Public Transport Victoria. Refer to ?ptvapi for more details.

api_key

Character. An API key, with dashes, provided by Public Transport Victoria. Refer to ?ptvapi for more details.

Details

The outlet_name reported here is more accurately described as an outlet address. We keep the outlet_name column name as this is how the PTV API describes it.

The business hours are reported as characters. Usually they take on a format of "8.00AM - 10.00PM", but there variants such as "7.30AM - 11.00AM and 1.30PM - 6.00PM". For days on which an outlet is closed, the opening hours are usually reported as "CLOSED", but can also be an empty character. Some opening hours are "24 Hours". These fields are also filled with missing values and empty characters.

Value

A tibble with the following columns:

Examples

1
2
3
4
## Not run: 
outlets()

## End(Not run)

ptvapi documentation built on May 2, 2021, 9:06 a.m.