TrackDiagrams.fetch_sample_catalogue

TrackDiagrams.fetch_sample_catalogue(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch catalogue of sample railway track diagrams 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

catalogue of sample railway track diagrams and date of when the catalogue was last updated

Return type

dict

Example:

>>> from pyrcs.line_data import TrackDiagrams

>>> td = TrackDiagrams()

>>> # trk_diagr_cat = td.fetch_sample_catalogue(update=True, verbose=True)
>>> trk_diagr_cat = td.fetch_sample_catalogue()

>>> type(trk_diagr_cat)
dict
>>> list(trk_diagr_cat.keys())
['Track diagrams', 'Last updated date']

>>> td_dat = trk_diagr_cat['Track diagrams']

>>> type(td_dat)
dict
>>> list(td_dat.keys())
['Main line diagrams', 'Tram systems', 'London Underground', 'Miscellaneous']

>>> main_line_diagrams = td_dat['Main line diagrams']

>>> type(main_line_diagrams)
tuple

>>> type(main_line_diagrams[1])
pandas.core.frame.DataFrame
>>> main_line_diagrams[1].head()
                             Description                               FileURL
0  South Central area (1985) 10.4Mb file  http://www.railwaycodes.org.uk/li...
1   South Eastern area (1976) 5.4Mb file  http://www.railwaycodes.org.uk/li...