describe_route_type: Convert a numeric route type to a human-friendly description

View source: R/route-types.R

describe_route_typeR Documentation

Convert a numeric route type to a human-friendly description

Description

This function effectively wraps the results of route_types to translate a route type to a human-readable form, such as translating 0 to "Train". This function is not vectorised.

Usage

describe_route_type(
  route_type,
  user_id = determine_user_id(),
  api_key = determine_api_key()
)

Arguments

route_type

Atomic integer or character.

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

character


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