Skip to contents

Query Regionalatlas data

Source: R/adapt_regionalatlas.R
regionalatlas_query.Rd

Query Regionalatlas data

Usage

regionalatlas_query(
  table,
  where = "1=1",
  out_fields = "*",
  return_geometry = FALSE,
  params = list(),
  safe = TRUE,
  refresh = FALSE
)

Arguments

table

Table name containing indicators (e.g., "ai002_1_5" for population density). See Details for common tables.

where

Optional SQL WHERE clause for filtering.

out_fields

Fields to return (default "*" for all).

return_geometry

Logical; include geometry in response.

params

Additional ArcGIS query parameters merged with adapter defaults. Common keys:

layer

JSON-encoded layer definition (set automatically from table).

where

SQL-like filter expression (set from where).

outFields

Fields to return (set from out_fields).

returnGeometry

Whether to include geometry ("true"/"false").

f

Output format ("json" by default).

spatialRel

Spatial relation, e.g. "esriSpatialRelIntersects".

safe

Logical; if TRUE (default), apply rate-limiting and cache GET responses to tools::R_user_dir("bunddev", "cache").

refresh

Logical; if TRUE, ignore cached responses and re-fetch from the API (default FALSE).

Value

A tibble with one row per geographic feature and columns:

ags

Character. Official municipality key (Amtlicher Gemeindeschluessel).

ags2

Character. Join key for indicator tables.

gen

Character. Region name.

typ

Integer. Administrative level (1=Bundeslaender, 2=Regierungsbezirke, 3=Kreise, 5=Gemeinden).

jahr

Integer. Reference year.

jahr2

Integer. Indicator reference year.

ai...

Numeric. Indicator values whose names depend on the selected table (e.g. ai0201 for population density).

Details

The Regionalatlas API provides access to over 160 regional indicators from the German statistical offices. Data is available at various administrative levels (Bundeslaender, Regierungsbezirke, Kreise, Gemeinden). API documentation: https://github.com/bundesAPI/regionalatlas-api.

Common tables and their indicators:

  • ai002_1_5: Population (ai0201=density, ai0202=change, ai0208=foreigners %)

  • ai002_4_5: Age (ai0218=average age, ai0219=mother age at 1st child)

  • ai008_1_5: Employment (ai0801=unemployment rate)

  • ai_s_01: Disposable income per capita

  • ai_s_04: SGB-II quota

  • ai017_1: GDP per employee

  • ai005: Federal election results

Regional levels in data: typ 1=Bundeslaender, 2=Regierungsbezirke, 3=Kreise, 5=Gemeinden. Filter using WHERE clause, e.g., where = "typ = 1".

See also

bunddev_parameters() for available query parameters.

Examples

if (FALSE) { # \dontrun{
# Population density indicators
regionalatlas_query("ai002_1_5")

# Filter for Bundeslaender only
regionalatlas_query("ai002_1_5", where = "typ = 1")

# Age data for Kreise
regionalatlas_query("ai002_4_5", where = "typ = 3")
} # }