LocationIdentifiers.fetch_explanatory_note

LocationIdentifiers.fetch_explanatory_note(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch multiple station codes explanatory note 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 multiple station codes explanatory note

Return type

dict

Example:

>>> from pyrcs.line_data import LocationIdentifiers

>>> lid = LocationIdentifiers()

>>> # exp_note = lid.fetch_explanatory_note(update=True, verbose=True)
>>> exp_note = lid.fetch_explanatory_note()

>>> type(exp_note)
dict
>>> list(exp_note.keys())
['Multiple station codes explanatory note', 'Notes', 'Last updated date']

>>> print(lid.MscENKey)
Multiple station codes explanatory note

>>> exp_note_dat = exp_note[lid.MscENKey]

>>> type(exp_note_dat)
pandas.core.frame.DataFrame
>>> exp_note_dat.head()
                 Location  CRS CRS_alt1 CRS_alt2
0    Glasgow Queen Street  GLQ      GQL
1         Glasgow Central  GLC      GCL
2                 Heworth  HEW      HEZ
3    Highbury & Islington  HHY      HII      XHZ
4  Lichfield Trent Valley  LTV      LIF