WaterTroughs.collect_codes

WaterTroughs.collect_codes(confirmation_required=True, verbose=False, raise_error=False)[source]

Collects codes of water troughs locations from the source web page.

Parameters:

  • confirmation_required (bool) – Whether user confirmation is required; if confirmation_required=True (default), prompts the user for confirmation before proceeding with data collection.

  • verbose (bool | int) – Whether to print relevant information to the console; defaults to False.

  • raise_error (bool) – Whether to raise the provided exception; if raise_error=False (default), the error will be suppressed.

Returns:

A dictionary containing the codes of water trough locations and the date they were last updated.

Return type:

dict | None

Examples:

>>>
>>> from pyrcs.other_assets import WaterTroughs  # from pyrcs import WaterTroughs
>>> wt = WaterTroughs()
>>> wt_codes = wt.collect_codes()
To collect data of water troughs
? [No]|Yes: yes
>>> type(wt_codes)
dict
>>> list(wt_codes.keys())
['Water troughs', 'Last updated date']
>>> wt.KEY
'Water troughs'
>>> wt_codes_dat = wt_codes[wt.KEY]
>>> type(wt_codes_dat)
pandas.core.frame.DataFrame
>>> wt_codes_dat.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]