TrackDiagrams.fetch_sample_catalogue

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

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

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

Return type

dict

Example:

>>> from pyrcs.line_data import TrackDiagrams

>>> td = TrackDiagrams()

>>> track_diagrams_catalog = td.fetch_sample_catalogue()

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

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