stop_information: Information for a given stop (metropolitan and V/Line...

View source: R/stops.R

stop_informationR Documentation

Information for a given stop (metropolitan and V/Line stations only)

Description

This function can be used when integer stop ID is already known. This can be searched for with either the stops_on_route or stops_nearby functions.

Usage

stop_information(
  stop_id,
  route_type,
  user_id = determine_user_id(),
  api_key = determine_api_key()
)

Arguments

stop_id

Integer stop ID.

route_type

A route type which can be provided either as a non-negative integer code, or as a character: "Tram", "Train", "Bus", "Vline" or "Night Bus". Character inputs are not case-sensitive. Use the route_types function to extract a vector of all route types.

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.

Value

A single-row tibble with the following columns:

  • stop_id

  • stop_name

  • route_type

  • route_type_description

  • station_details_id

  • station_type

  • station_description

  • point_id

  • mode_id

  • operating_hours

  • flexible_stop_opening_hours

  • stop_contact

  • stop_ticket

  • stop_location

  • stop_amenities

  • stop_accessibility

  • stop_staffing

  • disruption_ids


ptvapi documentation built on May 29, 2024, 4:48 a.m.