Features.fetch_codes¶
- Features.fetch_codes(update=False, dump_dir=None, verbose=False)[source]¶
Fetches the codes of infrastructure features.
Including:
- Parameters:
update (bool) – Whether to check for updates to the package data; defaults to
False.dump_dir (str | None) – The path to a directory where the data file will be saved; defaults to
None.verbose (bool | int) – Whether to print relevant information to the console; defaults to
False.
- Returns:
A dictionary containing the data of features codes and the date they were last updated.
- Return type:
dict
Examples:
>>> from pyrcs.other_assets import Features # from pyrcs import Features >>> feats = Features() >>> feats_codes = feats.fetch_codes() >>> type(feats_codes) dict >>> list(feats_codes.keys()) ['Features', 'Last updated date'] >>> feats.KEY 'Features' >>> feats_codes_dat = feats_codes[feats.KEY] >>> type(feats_codes_dat) dict >>> list(feats_codes_dat.keys()) ['Buzzer codes', 'HABD and WILD', 'Telegraphic codes', 'Water troughs'] >>> water_troughs_locations = feats_codes_dat[feats.KEY_TO_TROUGH] >>> type(water_troughs_locations) pandas.core.frame.DataFrame >>> water_troughs_locations.head() ELR ... Length (Yard) 0 BEI ... NaN 1 BHL ... 620.000000 2 CGJ2 ... 0.666667 3 CGJ6 ... 561.000000 4 CGJ6 ... 560.000000 [5 rows x 6 columns] >>> hw_codes_dat = feats_codes_dat[feats.KEY_TO_HABD_WILD] >>> type(hw_codes_dat) dict >>> list(hw_codes_dat.keys()) ['HABD', 'WILD'] >>> habd_dat = hw_codes_dat['HABD'] >>> type(habd_dat) pandas.core.frame.DataFrame >>> habd_dat.head() ELR ... Notes 0 BAG2 ... 1 BAG2 ... installed 29 September 1997, later moved to 74... 2 BAG2 ... previously at 74m 51ch 3 BAG2 ... removed 29 September 1997 4 BAG2 ... present in 1969, later moved to 89m 00ch [5 rows x 5 columns] >>> wild_dat = hw_codes_dat['WILD'] >>> type(wild_dat) pandas.core.frame.DataFrame >>> wild_dat.head() ELR ... Notes 0 AYR3 ... 1 BAG2 ... 2 BML1 ... 3 BML1 ... 4 CGJ3 ... moved to 183m 68ch from 8 September 2018 / mov... [5 rows x 5 columns]