Features.fetch_features_codes

Features.fetch_features_codes(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch features codes 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) – whether to print relevant information in console as the function runs, defaults to False

Returns

data of features codes and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.other_assets import Features

>>> features = Features()

>>> # feat_codes_dat = features.fetch_features_codes(update=True, verbose=True)
>>> feat_codes_dat = features.fetch_features_codes()

>>> type(feat_codes_dat)
dict
>>> list(feat_codes_dat.keys())
['Features', 'Last updated date']

>>> feat_codes = feat_codes_dat['Features']

>>> type(feat_codes)
dict
>>> list(feat_codes.keys())
['National network neutral sections',
 'Buzzer codes',
 'HABD and WILD',
 'Telegraphic codes',
 'Water troughs']

 >>> print(feat_codes['National network neutral sections'].head())
    ELR         OHNS Name  Mileage    Tracks Dates
0  ARG1        Rutherglen   0m 3ch
1  ARG2   Finnieston East  4m 23ch      Down
2  ARG2   Finnieston West  4m 57ch        Up
3  AYR1  Shields Junction  0m 68ch    Up Ayr
4  AYR1  Shields Junction  0m 69ch  Down Ayr