onstove.OnStove.extract_wealth_index#
- OnStove.extract_wealth_index(wealth_index: str, file_type: str = 'csv', x_column: str = 'longitude', y_column: str = 'latitude', wealth_column: str = 'rwi')[source]#
Extracts the relative wealth index to a column called relative wealth in the
gdf.The relative wealth index is used to determine the value of time and the value of time saved in subsequent calculations.
- Parameters:
- wealth_index: str
The path to the wealth index data used
- file_type: str, default “csv”
The file_type of the wealth index. The allowed file types are csv. point, polygon or raster
- x_column: str, default “longitude”
The name of the column containing x-coordinates, only relevant when file_type = csv
- y_column: str, default “latitude”
The name of the column containing y-coordinates, only relevant when file_type = csv
- wealth_column: str, default “latitude”
The name of the column containing the wealth index, only relevant when file type is either csv, point or polygon
See also