Tunnels.fetch_tunnel_lengths

Tunnels.fetch_tunnel_lengths(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch data of railway tunnel lengths 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

data of railway tunnel lengths (including the name, length, owner and relative location) and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.other_assets import Tunnels

>>> tunl = Tunnels()

>>> # tunl_len_data = tunl.fetch_tunnel_lengths(update=True, verbose=True)
>>> tunl_len_data = tunl.fetch_tunnel_lengths()

>>> type(tunl_len_data)
dict
>>> list(tunl_len_data.keys())
['Tunnels', 'Last updated date']

>>> print(tunl.Key)
Tunnels

>>> tunl_len_dat = tunl_len_data[tunl.Key]

>>> type(tunl_len_dat)
dict
>>> list(tunl_len_dat.keys())
['Page 1 (A-F)', 'Page 2 (G-P)', 'Page 3 (Q-Z)', 'Page 4 (others)']

>>> page_1 = tunl_len_dat['Page 1 (A-F)']

>>> type(page_1)
pandas.core.frame.DataFrame
>>> page_1.head()
             Name  Other names, remarks  ...   Length_metres Length_notes
0    Abbotscliffe                        ...       1775.7648          NaN
1      Abercanaid           see Merthyr  ...             NaN  Unavailable
2     Aberchalder         see Loch Oich  ...             NaN  Unavailable
3  Aberdovey No 1  also called Frongoch  ...        182.8800          NaN
4  Aberdovey No 2    also called Morfor  ...        200.2536          NaN
[5 rows x 12 columns]