Skip to contents

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.

Usage

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

Arguments

as_list

This options controls the output format. The output is either a named list or an atomic vector with the available sections

format

Specify a format type. The function now returns only available sections that can respond with that format. Currently geojson is the only format that is specified.

verbose

whether or not to provide {cli} output for the user. Enabled by default, but disabled for all functions that wrap this function

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()
#>  [1] "adgangsadresser"                   "adresser"                         
#>  [3] "afstemningsomraader"               "autocomplete"                     
#>  [5] "bebyggelser"                       "bygninger"                        
#>  [7] "ejerlav"                           "jordstykker"                      
#>  [9] "kommuner"                          "landsdele"                        
#> [11] "menighedsraadsafstemningsomraader" "navngivneveje"                    
#> [13] "opstillingskredse"                 "politikredse"                     
#> [15] "postnumre"                         "postnumre"                        
#> [17] "regioner"                          "retskredse"                       
#> [19] "sogne"                             "steder"                           
#> [21] "stednavne2"                        "stednavntyper"                    
#> [23] "storkredse"                        "supplerendebynavne2"              
#> [25] "supplerendebynavne2"               "valglandsdele"                    
#> [27] "vejnavne"                          "vejnavnpostnummerrelationer"      
#> [29] "vejstykker"                       

available_sections(as_list = TRUE)
#> $adresser
#> [1] "adgangsadresser"             "adresser"                   
#> [3] "autocomplete"                "navngivneveje"              
#> [5] "vejstykker"                  "vejnavne"                   
#> [7] "vejnavnpostnummerrelationer" "supplerendebynavne2"        
#> [9] "postnumre"                  
#> 
#> $dagi
#>  [1] "afstemningsomraader"               "kommuner"                         
#>  [3] "landsdele"                         "menighedsraadsafstemningsomraader"
#>  [5] "opstillingskredse"                 "politikredse"                     
#>  [7] "postnumre"                         "regioner"                         
#>  [9] "retskredse"                        "sogne"                            
#> [11] "storkredse"                        "supplerendebynavne2"              
#> [13] "valglandsdele"                    
#> 
#> $matrikelkortet
#> [1] "ejerlav"     "jordstykker"
#> 
#> $stednavne
#> [1] "steder"        "stednavne2"    "stednavntyper" "bebyggelser"  
#> 
#> $bygningspolygoner
#> [1] "bygninger"
#>