LocationIdentifiers.collect_explanatory_note¶

LocationIdentifiers.collect_explanatory_note(confirmation_required=True, verbose=False)[source]¶

Collect note about CRS code from source web page.

Parameters

confirmation_required (bool) – whether to prompt a message for confirmation to proceed, defaults to True
verbose (bool or int) – whether to print relevant information in console as the function runs, defaults to False

Returns

data of multiple station codes explanatory note

Return type

dict or None

Example:

>>> from pyrcs.line_data import LocationIdentifiers

>>> lid = LocationIdentifiers()

>>> exp_note = lid.collect_explanatory_note(confirmation_required=False)

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

>>> print(exp_note['Multiple station codes explanatory note'].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