Depots.fetch_gwr_codes

Depots.fetch_gwr_codes(update=False, pickle_it=False, data_dir=None, verbose=False)[source]

Fetch Great Western Railway (GWR) depot codes from local backup.

Parameters

  • update (bool) – whether to check on update and proceed to update the package data, defaults to False

  • pickle_it (bool) – whether to replace the current package data with newly collected data, defaults to False

  • data_dir (str or None) – name of package data folder, defaults to None

  • verbose (bool) – whether to print relevant information in console as the function runs, defaults to False

Returns

data of GWR depot codes and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.other_assets import Depots

>>> depots = Depots()

>>> gwr_codes_dat = depots.fetch_gwr_codes()

>>> gwr_codes = gwr_codes_dat['GWR codes']
>>> type(gwr_codes)
<class 'dict'>
>>> print(list(gwr_codes.keys()))
['Alphabetical codes', 'Numerical codes']

>>> gwr_codes_alpha = gwr_codes['Alphabetical codes']
>>> type(gwr_codes_alpha)
<class 'pandas.core.frame.DataFrame'>
>>> print(gwr_codes_alpha.head())
    Code   Depot name
0  ABEEG     Aberbeeg
1    ABG     Aberbeeg
2    AYN    Abercynon
3   ABDR     Aberdare
4    ABH  Aberystwyth