In RedTent/aquodom: Access to Aquo domaintables from R (Dutch)

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

aquodom

Met aquodom is het op eenvoudige wijze mogelijk om de aquo-domeintabellen te downloaden en te gebruiken in R. De website voor aquodom is te vinden via https://redtent.github.io/aquodom.

Installatie

aquodom is te installeren vanaf CRAN met:

install.packages("aquodom") 

De ontwikkelversie is te installeren van GitHub met:

# install.packages("devtools")
devtools::install_github("RedTent/aquodom")

Aquo-domeintabellen

De Aquo-standaard vormt de Nederlandse standaard voor de uitwisseling van gegevens in het waterbeheer. Met aquodom (kort voor aquo-domeintabellen) is het makkelijk om via de API domeintabellen van de Aquo-standaard in R te downloaden en te gebruiken.

De belangrijkste functies van aquodom zijn dom() en dom_save(). Met deze functies kan iedere domeintabel van www.aquo.nl worden gedownload. De functie dom() geeft de domeintabel als een dataframe. dom_save() doet hetzelfde maar slaat daarnaast ook de domeintabel op als xlsx- of csv-bestand. De functie dom_overzicht() geeft een compleet overzicht van alle beschikbare domeintabellen.

Alle functies hebben een optioneel argument peildatum. Dit argument kan worden gebruikt om alleen domeinwaarden of domeintabellen te tonen die geldig zijn op de peildatum. Met peildatum = NULL worden alle resultaten inclusief verouderde waarden getoond.

library(aquodom)

dom("MonsterType")

#De namen van domeintabellen zijn niet hoofdlettergevoelig
all.equal(dom("MonsterType"), dom("monstertype"))

# Alle domeinwaarden inclusief verouderde waarden
dom("MonsterType", peildatum = NULL)

head(dom_overzicht(), 3)

nrow(dom_overzicht())
# inclusief ongeldige domeintabellen
nrow(dom_overzicht(peildatum = NULL))

dom_save("monstertype")

Caching en opslaan

Het downloaden van grotere domeintabellen kan behoorlijk wat tijd in beslag nemen. Daarom maakt aquodom gebruik van caching. Als een domeintabel eenmaal is gedownload wordt in dezelfde R-sessie gebruik gemaakt van de cache. Voor het gebruik van dezelfde domeintabel in verschillende R-sessies kan de domeintabel het beste opgeslagen worden, bijv. met dom_save().

# De eerste keer duurt vrij lang
system.time(dom("Hoedanigheid"))

# De tweede keer gaat veel sneller
system.time(dom("Hoedanigheid"))

RedTent/aquodom documentation built on March 25, 2022, 6:49 a.m.