spod_get_zones: Get zones
In spanishoddata: Get Spanish Origin-Destination Data

spod_get_zones

R Documentation

Get zones

Description

Get spatial zones for the specified data version. Supports both v1 (2020-2021) and v2 (2022 onwards) data.

Usage

spod_get_zones(
  zones = c("districts", "dist", "distr", "distritos", "municipalities", "muni",
    "municip", "municipios", "lua", "large_urban_areas", "gau", "grandes_areas_urbanas"),
  ver = NULL,
  data_dir = spod_get_data_dir(),
  quiet = FALSE
)

Arguments

`zones`	The zones for which to download the data. Can be `"districts"` (or `"dist"`, `"distr"`, or the original Spanish `"distritos"`) or `"municipalities"` (or `"muni"`, `"municip"`, or the original Spanish `"municipios"`) for both data versions. Additionaly, these can be `"large_urban_areas"` (or `"lua"`, or the original Spanish `"grandes_areas_urbanas"`, or `"gau"`) for v2 data (2022 onwards).
`ver`	Integer. Can be 1 or 2. The version of the data to use. v1 spans 2020-2021, v2 covers 2022 and onwards.
`data_dir`	The directory where the data is stored. Defaults to the value returned by `spod_get_data_dir()` which returns the value of the environment variable `SPANISH_OD_DATA_DIR` or a temporary directory if the variable is not set. To set the data directory, use spod_set_data_dir.
`quiet`	A `logical` value indicating whether to suppress messages. Default is `FALSE`.

Value

An sf object (Simple Feature collection).

The columns for v1 (2020-2021) data include:

id: A character vector containing the unique identifier for each district, assigned by the data provider. This id matches the id_origin, id_destination, and id in district-level origin-destination and number of trips data.
census_districts: A string with semicolon-separated identifiers of census districts classified by the Spanish Statistical Office (INE) that are spatially bound within the polygons for each id.
municipalities_mitma: A string with semicolon-separated municipality identifiers (as assigned by the data provider) corresponding to each district id.
municipalities: A string with semicolon-separated municipality identifiers classified by the Spanish Statistical Office (INE) corresponding to each id.
district_names_in_v2/municipality_names_in_v2: A string with semicolon-separated district names (from the v2 version of this data) corresponding to each district id in v1.
district_ids_in_v2/municipality_ids_in_v2: A string with semicolon-separated district identifiers (from the v2 version of this data) corresponding to each district id in v1.
geometry: A MULTIPOLYGON column containing the spatial geometry of each district, stored as an sf object. The geometry is projected in the ETRS89 / UTM zone 30N coordinate reference system (CRS), with XY dimensions.

The columns for v2 (2022 onwards) data include:

id: A character vector containing the unique identifier for each zone, assigned by the data provider.
name: A character vector with the name of each district.
population: A numeric vector representing the population of each district (as of 2022).
census_sections: A string with semicolon-separated identifiers of census sections corresponding to each district.
census_districts: A string with semicolon-separated identifiers of census districts as classified by the Spanish Statistical Office (INE) corresponding to each district.
municipalities: A string with semicolon-separated identifiers of municipalities classified by the Spanish Statistical Office (INE) corresponding to each district.
municipalities_mitma: A string with semicolon-separated identifiers of municipalities, as assigned by the data provider, that correspond to each district.
luas_mitma: A string with semicolon-separated identifiers of LUAs (Local Urban Areas) from the provider, associated with each district.
district_ids_in_v1/municipality_ids_in_v1: A string with semicolon-separated district identifiers from v1 data corresponding to each district in v2. If no match exists, it is marked as NA.
geometry: A MULTIPOLYGON column containing the spatial geometry of each district, stored as an sf object. The geometry is projected in the ETRS89 / UTM zone 30N coordinate reference system (CRS), with XY dimensions.

Examples



# get polygons for municipalities for the v2 data
municip_v2 <- spod_get_zones(zones = "municipalities", ver = 2)

# get polygons for the districts for the v1 data
distr_v1 <- spod_get_zones(zones = "districts", ver = 1)

spanishoddata documentation built on April 12, 2025, 1:24 a.m.