Title:	An API Wrapper for 'DAWA' - 'The Danish Address Web API'
Date:	2025-02-13
Version:	0.3.0
Description:	Functions for interacting with all sections of the official 'Danish Address Web API' (also known as 'DAWA') https://api.dataforsyningen.dk. The development of this package is completely independent from the government agency, Klimadatastyrelsen, who maintains the API.
License:	GPL (≥ 3)
Encoding:	UTF-8
RoxygenNote:	7.3.2
URL:	https://dawar.aleksanderbl.dk/, https://github.com/aleksanderbl29/dawaR
BugReports:	https://github.com/aleksanderbl29/dawaR/issues
Suggests:	knitr, rmarkdown, ggplot2, testthat (≥ 3.0.0), cowplot (≥ 1.1.0), rmapshaper (≥ 0.5.0), microbenchmark (≥ 1.5.0), pkgdown, dplyr, devtools, vcr (≥ 0.6.0)
Config/testthat/edition:	3
Config/testthat/parallel:	true
Depends:	R (≥ 4.1.0)
Imports:	memoise (≥ 2.0.0), cli, httr2, sf, tidyRSS, rlang, curl, utils
VignetteBuilder:	knitr
NeedsCompilation:	no
Packaged:	2025-02-13 16:00:40 UTC; aleksander
Author:	Aleksander Bang-Larsen [aut, cre, cph], Agency of Climate Data [ctb] (The Danish Agency of Climate Data provides this API for the public and have not actively contributed to the development nor distribution in this package.)
Maintainer:	Aleksander Bang-Larsen <contact@aleksanderbl.dk>
Repository:	CRAN
Date/Publication:	2025-02-13 17:10:05 UTC

Base function for interacting with autocomplete of sections.

Description

This function is very handy when needing to either validate or simply "fill in gaps" with autocompletion from the API.

Usage

autocomplete(section, input, ...)

Arguments

Value

Returns the autocomplete information for the provided section given the input.

Examples

if (connection_check()) {
  autocomplete("regioner", "midt")
}

List of available sections for dawa()

Description

Simple function to list all available options for the section parameter in dawa(). Useful when getting to know the base api function of this package. To filter based on funciton usage you can provide format = "geojson" to ensure compatability with get_map_data() and func = "get_data" to ensure compatability with get_data().

Usage

available_sections(as_list = FALSE, format = NULL, verbose = TRUE, func = NULL)

Arguments

Value

The function returns either a named list or an atomic vector with the available sections in the API. The format is decided by as_list.

Examples

available_sections()

available_sections(as_list = TRUE)

Check that R has access to resources at ⁠https://api.dataforsyningen.dk⁠

Description

Check that R has access to resources at ⁠https://api.dataforsyningen.dk⁠

Usage

connection_check()

Value

Returns a logical

See Also

Other Connection checks: status_check()

Examples

connection_check()

Base API function

Description

This function is the foundation of all communication with the api in this package. Not intended for end-users, but it provides all the flexibility of the api without the nice conveniences of the other functions in this package. By default it reformats the api response (which is json) to a list object.

Usage

dawa(
  section,
  ...,
  append_to_url = NULL,
  format = NULL,
  verbose = TRUE,
  cache = TRUE,
  dry_run = FALSE,
  func_params = list()
)

Arguments

Value

By default returns the API response as a list output. For geojson(z) formats it returns the raw json. When dry_run = TRUE it returns the request that has been created but does not run it.

Examples

if (connection_check()) {
  x <- dawa(section = "sogne")

  x[[1]]
}

Get data from section

Description

Get data from section

Usage

get_data(section, as_list = FALSE, ...)

Arguments

Value

Returns either a dataframe with all the data for the specified section or a list with the same information.

See Also

Other Data functions: get_map_data()

Examples

if (connection_check()) {
  x <- get_data("regioner")
  head(x)
}

Fetch map data to use with {sf}.

Description

This function returns map data from DAWA. It is ready to use with {sf} functions. The returned dataframe has date-time columns to inform when the information was last changed. It is returned in Europe/Copenhagen time as that is the local time for the API. You can change that behavior by setting Sys.setenv(TZ = "Your/Timezone").

Usage

get_map_data(type, cache = TRUE, ...)

Arguments

Value

Returns a data.frame object that contains polygons (or points) for the section provided.

See Also

Other Data functions: get_data()

Examples

## Not run: 
x <- get_map_data("regioner")
ggplot2::ggplot(x) +
  ggplot2::geom_sf()

## End(Not run)

Base function for interacting with ⁠reverse geocoding⁠ of sections.

Description

This function reverse geocodes the coordinates provided. When used out of the box, the function wants WGS84 coordinates (lat/long). ETRS89 or UTM zone 32 can be provided as well. When coordinates from outside of Denmark is provided, the function will fail with a code 404.

Usage

reverse(section, x, y, verbose = TRUE, type = NULL, ...)

Arguments

Value

Returns a list object with information about the provided section for the location that is input.

Examples

if (connection_check()) {
  reverse("regioner", x = 12.58515, y = 55.68324)
}

Check that all DAWA services are operational

Description

This function fetches the status of all available SDFI services. This package depends on at least one of these. It checks the official status page. The status can also be followed on their official X-page ⁠@DriftDataforsyn⁠.

Usage

status_check(return_df = FALSE, error_if_unavailable = FALSE)

Arguments

Value

Returns a data frame object with the services and their statuses. Is only returned if return_df = TRUE.

Note

Please note that the status at the status page is only checked at regular intervals. If you would like to know if your machine can access the serviceses, please try connection_check() as well.

See Also

Other Connection checks: connection_check()

Examples

if (connection_check()) {
  status_check()

  status_check(return_df = TRUE)
}