disruption_information: Information on a particular disruption

View source: R/disruptions.R

disruption_informationR Documentation

Information on a particular disruption

Description

This function can be used when the integer disruption ID is already known. This can be searched for with either disruptions, disruptions_on_route, or disruptions_at_stop functions.

Usage

disruption_information(
  disruption_id,
  user_id = determine_user_id(),
  api_key = determine_api_key()
)

Arguments

disruption_id

Integer.

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 tibble with the following columns:

  • disruption_mode

  • disruption_mode_description

  • disruption_id

  • title

  • url

  • description

  • disruption_status

  • disruption_type

  • published_on

  • last_updated

  • from_date

  • to_date

  • routes

  • stops

  • colour

  • display_on_board

  • display_status

Examples

## Not run: 
disruption_information(206639)

## End(Not run)


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