LocationIdentifiers.fetch_explanatory_note

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

Fetch multiple station codes explanatory note.

Parameters

  • update (bool) – whether to do an update check (for the package data), defaults to False

  • dump_dir (str or None) – pathname of a directory where the data file is dumped, 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

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
                   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
5     Liverpool Lime Street  LIV      LVL
6   Liverpool South Parkway  LPY      ALE
7         London St Pancras  STP      SPL      SPX
8                   Retford  RET      XRO
9   Smethwick Galton Bridge  SGB      GTI
10                 Tamworth  TAM      TAH
11       Willesden Junction  WIJ      WJH      WJL
12   Worcestershire Parkway  WOP      WPH