LocationIdentifiers.fetch_explanatory_note¶
-
LocationIdentifiers.
fetch_explanatory_note
(update=False, pickle_it=False, data_dir=None, verbose=False)[source]¶ Fetch multiple station codes explanatory note from local backup.
- Parameters
update (bool) – whether to check on update and proceed to update the package data, defaults to
False
pickle_it (bool) – whether to replace the current package data with newly collected data, defaults to
False
data_dir (str or None) – name of package data folder, defaults to
None
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
Example:
>>> from pyrcs.line_data import LocationIdentifiers >>> lid = LocationIdentifiers() >>> exp_note = lid.fetch_explanatory_note( ... update=False, pickle_it=False, data_dir=None, verbose=True) >>> type(exp_note) <class 'dict'> >>> print(list(exp_note.keys())) ['Multiple station codes explanatory note', 'Notes', 'Last updated date']