LocationIdentifiers.fetch_explanatory_note

LocationIdentifiers.fetch_explanatory_note(update=False, dump_dir=None, verbose=False)[source]

Fetches the explanatory note for multiple station codes (CRS codes).

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 data of the multiple station codes explanatory note.

Return type:

dict

Examples:

>>> from pyrcs.line_data import LocationIdentifiers
>>> # from pyrcs import LocationIdentifiers
>>> lid = LocationIdentifiers()
>>> exp_note = lid.fetch_explanatory_note()
>>> type(exp_note)
dict
>>> list(exp_note.keys())
['Multiple station codes explanatory note', 'Notes', 'Last updated date']
>>> lid.KEY_TO_MSCEN
'Multiple station codes explanatory note'
>>> exp_note_dat = exp_note[lid.KEY_TO_MSCEN]
>>> type(exp_note_dat)
pandas.core.frame.DataFrame
>>> exp_note_dat.head()
                 Location  CRS CRS_alt1 CRS_alt2
0         Glasgow Central  GLC      GCL
1    Glasgow Queen Street  GLQ      GQL
2                 Heworth  HEW      HEZ
3    Highbury & Islington  HHY      HII      XHZ
4  Lichfield Trent Valley  LTV      LIF