Package 'aquodom'

Title: Access to Aquo domaintables from R (Dutch)
Description: The Aquo Standard is the Dutch Standard for the exchange of data in water management. With *aquodom* (short for aquo domaintables) it is easy to exploit the API (<https://www.aquo.nl/index.php/Hoofdpagina>) to download domaintables of the Aquo Standard and use them in R.
Authors: Johan van Tent [aut, cre]
Maintainer: Johan van Tent <[email protected]>
License: MIT + file LICENSE
Version: 0.1.1
Built: 2025-02-11 02:56:24 UTC
Source: https://github.com/redtent/aquodom

Help Index

Opvragen domeintabel

Description

Deze functie haalt een domeintabel op van www.aquo.nl.

Usage

dom(naam, peildatum = Sys.Date())

Arguments

naam

Naam van een domeintabel - De namen zijn niet hoofdlettergevoelig. Zie dom_overzicht() voor geldige domeintabelnamen.
peildatum

Date of een character die omgezet kan worden in een Date met lubridate::as_date(). De peildatum filtert de output om alleen geldige domeinwaarden op de peildatum weer te geven. Gebruik NULL om alle domeinwaarden ongeacht de geldigheid weer te geven.

Value

Een tibble met een met domeinwaarden. De kolommen zijn afhankelijk van de betreffende domeintabel.

Caching

Deze functie maakt gebruik van caching voor het optimaliseren van snelheid en om de aquo-server niet onnodig te belasten. Hiervoor wordt de map tempdir() gebruikt als cache. Deze map wordt na elke R-sessie verwijderd.

See Also

Other domeintabellen: dom_overzicht(), dom_save()

Examples

## Not run: 

dom("MonsterType")
dom("MonsterType", peildatum = Sys.Date())
dom("MonsterType", peildatum = "2021-04-05")


## End(Not run)

Guid van domeintabel

Description

Zoek de guid van domeintabellen op.

Usage

dom_guid(namen)

Arguments

namen

Character vector met namen van domeintabellen.

Value

Vector met guid's

Examples

## Not run: 

dom_guid("MonsterType")


## End(Not run)

Kolommen van een domeintabel

Description

Deze functie zoekt op welke kolommen een domeintabel heeft.

Usage

dom_kolommen(naam)

Arguments

naam

Naam van een domeintabel

Value

Een vector met kolomnamen

Examples

## Not run: 

dom_kolommen("MonsterType")


## End(Not run)

Overzicht van alle domeintabellen

Description

Deze functie geeft een overzicht van alle beschikbare domeintabellen, inclusief historische tabellen, op www.aquo.nl.

Usage

dom_overzicht(peildatum = Sys.Date())

Arguments

peildatum

Date of een character die omgezet kan worden in een Date met lubridate::as_date(). De peildatum filtert de output om alleen geldige domeintabellen op de peildatum weer te geven. Gebruik NULL om alle domeintabellen ongeacht de geldigheid weer te geven.

Value

Een tibble met een overzicht van alle domeintabellen. Het overzicht bevat de volgende kolommen:

  • domeintabel - Naam van de domeintabel.

  • domeintabelsoort - Het type domeintabel.

  • wijzigingsdatum - Datum van de laatste wijziging van de tabel.

  • begin_geldigheid - Datum van het begin van de geldigheid van de domeintabel.

  • eind_geldigheid - Datum van het eind van de geldigheid van de domeintabel.

  • kolommen - Een vector met de kolomnamen van de domeintabel.

  • guid - De guid van de domeintabel.

Caching

Deze functie maakt gebruik van caching voor het optimaliseren van snelheid en om de aquo-server niet onnodig te belasten. Hiervoor wordt de map tempdir() gebruikt als cache. Deze map wordt na elke R-sessie verwijderd.

See Also

Other domeintabellen: dom_save(), dom()

Examples

## Not run: 

dom_overzicht()
dom_overzicht(peildatum = Sys.Date())
dom_overzicht(peildatum = "2021-04-05")


## End(Not run)

Opslaan domeintabel

Description

Met deze functie is het mogelijk om een domeintabel op te slaan als .xlsx-bestand of als .csv-bestand.

Usage

dom_save(
  naam,
  bestandsnaam = paste(Sys.Date(), naam),
  map = NULL,
  bestandstype = c("xlsx", "csv"),
  peildatum = Sys.Date()
)

Arguments

naam

Naam van een domeintabel - De namen zijn niet hoofdlettergevoelig. Zie dom_overzicht() voor geldige domeintabelnamen.
bestandsnaam

Naam van het bestand om op te slaan. Eventueel als volledig pad. Default is de datum gevolgd door de naam van de domeintabel. De bestandsnaam mag zonder extensie worden opgegeven.
map

Naam van de map. De map moet bestaan. Optioneel.
bestandstype

"xlsx" of "csv" Opslaan als xlsx of als csv-bestand. Default is xlsx.
peildatum

Date of een character die omgezet kan worden in een Date met lubridate::as_date(). De peildatum filtert de output om alleen geldige domeinwaarden op de peildatum weer te geven. Gebruik NULL om alle domeinwaarden ongeacht de geldigheid weer te geven.

Details

Voor het opslaan van een bestand als .xlsx wordt openxlsx::write.xlsx() gebruikt. Voor het opslaan als .csv wordt readr::write_csv2() gebruikt.

Opgeslagen excelbestanden kunnen ingelezen worden met openxlsx::read.xlsx() of readxl::read_excel(). csv-bestanden kunnen worden ingelezen met readr::read_csv2()

Value

Slaat de domeintabel op de schijf. De domeintabel zelf wordt onzichtbaar geretourneerd.

See Also

Other domeintabellen: dom_overzicht(), dom()

Examples

## Not run: 
 dom_save("MonsterType")
 dom_save("MonsterType", bestandsnaam = "test.csv", map = "data", bestandstype = "csv")


## End(Not run)

Check domeintabelnamen

Description

Checkt of een namen geldige domeintabelnamen zijn.

Usage

is_domeintabel(namen)

Arguments

namen

Character vector met namen van domeintabellen.

Value

Logical vector

Examples

## Not run: 

is_domeintabel("MonsterType")
is_domeintabel("Domeintabel")


## End(Not run)