## vectordata.GeoVectorData


Abstract class for datasets containing geospatial vector data.


Usage

``` python
vectordata.GeoVectorData(cache_dir=None)
```


## Attributes

| Name | Description |
|----|----|
| [metadata](#metadata) | Metadata container for dataset attribution and licensing. |
| [processed_path](#processed_path) | Path to the processed data. |
| [raw_path](#raw_path) | Path to the raw downloaded data. |

------------------------------------------------------------------------


#### metadata


Metadata container for dataset attribution and licensing.


`metadata: DatasetMetadata`


------------------------------------------------------------------------


#### processed_path


Path to the processed data.


`processed_path: Path`


------------------------------------------------------------------------


#### raw_path


Path to the raw downloaded data.


`raw_path: Path`


## Methods

| Name | Description |
|----|----|
| [__init__()](#__init__) | Initialize the dataset. |
| [__repr__()](#__repr__) | Return the technical string representation. |
| [cleanup()](#cleanup) | Remove cached dataset files, keeping the processed data by default. |
| [get_data()](#get_data) | Return the processed data, preparing it if necessary. |

------------------------------------------------------------------------


#### \_\_init\_\_()


Initialize the dataset.


Usage

``` python
__init__(cache_dir=None)
```


##### Parameters


`cache_dir: str or Path or None = None`  
The root directory where the dataset is stored. Defaults to the 'FREEZEBASE_CACHE' environment variable or the system cache directory (in that order).


------------------------------------------------------------------------


#### \_\_repr\_\_()


Return the technical string representation.


Usage

``` python
__repr__()
```


------------------------------------------------------------------------


#### cleanup()


Remove cached dataset files, keeping the processed data by default.


Usage

``` python
cleanup(*, raw=True, processed=False)
```


By default removes only the raw download to free cache space while keeping the processed GeoParquet. Pass `processed=True` to also remove the processed data (e.g. to wipe the dataset entirely), or `raw=False, processed=True` to remove only the processed data.

Overwrite this method if the raw or processed paths are directories (e.g., an extracted ZIP) instead of single files.


------------------------------------------------------------------------


#### get_data()


Return the processed data, preparing it if necessary.


Usage

``` python
get_data(*, download=False)
```