LineNames.fetch_line_names

LineNames.fetch_line_names(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch data of railway line names from local backup.

Parameters

• update (bool) – whether to do an update check (for the package data), defaults to False

• pickle_it (bool) – whether to save the data as a pickle file, defaults to False

• data_dir (str or None) – name of a folder where the pickle file is to be saved, defaults to None

• verbose (bool or int) – whether to print relevant information in console, defaults to False

Returns

railway line names and routes data and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.line_data import LineNames

>>> ln = LineNames()

>>> # line_names_dat = ln.fetch_line_names(update=True, verbose=True)
>>> line_names_dat = ln.fetch_line_names()

>>> type(line_names_dat)
dict
>>> list(line_names_dat.keys())
['Line names', 'Last updated date']

>>> print(ln.Key)
Line names

>>> line_names_codes = line_names_dat['Line names']

>>> type(line_names_codes)
pandas.core.frame.DataFrame
>>> line_names_codes.head()
             Line name  ... Route_note
0           Abbey Line  ...       None
1        Airedale Line  ...       None
2          Argyle Line  ...       None
3     Arun Valley Line  ...       None
4  Atlantic Coast Line  ...       None
[5 rows x 3 columns]