Viaducts.fetch_codes

Viaducts.fetch_codes(update=False, dump_dir=None, verbose=False)

Fetch data of railway viaducts.

Parameters

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

  • dump_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

data of railway viaducts and date of when the data was last updated

Return type

dict

Examples:

>>> from pyrcs.other_assets import Viaducts  # from pyrcs import Viaducts

>>> vdct = Viaducts()

>>> vdct_codes = vdct.fetch_codes()
>>> type(vdct_codes)
dict
>>> list(vdct_codes.keys())
['Viaducts', 'Last updated date']

>>> vdct.KEY
'Viaducts'

>>> vdct_codes_dat = vdct_codes[vdct.KEY]
>>> type(vdct_codes_dat)
dict
>>> list(vdct_codes_dat.keys())
['Page 1 (A-C)',
 'Page 2 (D-G)',
 'Page 3 (H-K)',
 'Page 4 (L-P)',
 'Page 5 (Q-S)',
 'Page 6 (T-Z)']

>>> page_6_codes = vdct_codes_dat['Page 6 (T-Z)']
>>> type(page_6_codes)
pandas.core.frame.DataFrame
>>> page_6_codes.head()
         Name                                  Notes  ... End mileage Spans
0   Tadcaster  crosses River Wharfe; grade II listed  ...                11
1        Taff                         see Red Bridge  ...
2        Taff                                         ...
3  Taff River                  also called Afon Taff  ...   170m 42ch
4  Taffs Well                         see River Taff  ...
[5 rows x 7 columns]