TrackDiagrams.fetch_catalogue¶

TrackDiagrams.fetch_catalogue(update=False, dump_dir=None, verbose=False)[source]¶

Fetches the catalogue of railway track diagrams.

Parameters:

update (bool) – Whether to check for updates to the package data; defaults to False.
dump_dir (str | None) – The path to a directory where the data file will be saved; defaults to None.
verbose (bool | int) – Whether to print relevant information to the console; defaults to False.

Returns:

A dictionary containing the catalogue of railway track diagrams and the date it was last updated.

Return type:

dict

Examples:

>>> from pyrcs.line_data import TrackDiagrams  # from pyrcs import TrackDiagrams
>>> td = TrackDiagrams()
>>> trk_diagr_cat = td.fetch_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/line/track/d...
1   South Eastern area (1976) 5.4Mb file  http://www.railwaycodes.org.uk/line/track/d...