Rail_Patronage: Retrieve the patronage of railway system.

In ChiaJung-Yeh/NYCU_TDX: Connecting transportation data from TDX, Taiwan.

Retrieve the patronage of railway system.

Description

The function is used to download the patronage data of railway system. This is now currently available for the Taiwan Railway (TRA) and TRTC (Taipei MRT).

Usage

Rail_Patronage(operator, ym, OD, out=F)

Arguments

operator	Please fill in the operator code of given railway system. Checking out the appropriate operator code in dataframe TDX_Railway. This is currently now only for Taiwan Railway (TRA) and Taipei MRT (TRTC).
ym	The time (year-month) of the data. The format of time should be YYYY-MM.
OD	If the OD data is required, please specified 'TRUE'; otherwise, the total station patronage will be downloaded. This is currently only available for Taipei MRT (TRTC).
out	If the result should be exported to the local, please fill in the directory. The default value is FALSE, which does not export the data.

Value

Columns definition of the results are summarized below.

	gateIn	Station name of inbound.
	gateOut	Station name of outbound.
	gateInComingCnt	Total patronage of inbound.
	gateOutGoingCnt	Total patronage of outbound.

Author(s)

Maintainer: Chia Jung, Yeh [e-mail]

Examples

# Download the total patronage data for Taiwan Railway
Rail_Patronage(operator="TRA", ym="2024-01", OD=F)

# Download the OD data for Taipei MRT
Rail_Patronage(operator="TRTC", ym="2024-01", OD=T, out="TRTC_OD.csv")

ChiaJung-Yeh/NYCU_TDX documentation built on Jan. 21, 2025, 4:44 a.m.